alexaforbusiness

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package alexaforbusiness provides the client and types for making API requests to Alexa For Business.

Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit, and the Alexa for Business APIs, and you can make these available as private skills for your organization. Alexa for Business also makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.

See https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09 for more information on this service.

See alexaforbusiness package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/alexaforbusiness/

Using the Client

To Alexa For Business with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Alexa For Business client AlexaForBusiness for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/alexaforbusiness/#New

Index

Constants

View Source
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The resource being created already exists. HTTP Status Code: 400
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeInvalidUserStatusException for service response error code
	// "InvalidUserStatusException".
	//
	// The attempt to update a user is invalid due to the user's current status.
	// HTTP Status Code: 400
	ErrCodeInvalidUserStatusException = "InvalidUserStatusException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You are performing an action that would put you beyond your account's limits.
	// HTTP Status Code: 400
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNameInUseException for service response error code
	// "NameInUseException".
	//
	// The name sent in the request is already in use. HTTP Status Code: 400
	ErrCodeNameInUseException = "NameInUseException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The resource is not found. HTTP Status Code: 400
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource in the request is already in use. HTTP Status Code: 400
	ErrCodeResourceInUseException = "ResourceInUseException"
)
View Source
const (
	ServiceName = "a4b"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AlexaForBusiness

type AlexaForBusiness struct {
	*aws.Client
}

AlexaForBusiness provides the API operation methods for making requests to Alexa For Business. See this package's package overview docs for details on the service.

AlexaForBusiness methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *AlexaForBusiness

New creates a new instance of the AlexaForBusiness client with a config.

Example:

// Create a AlexaForBusiness client from just a config.
svc := alexaforbusiness.New(myConfig)

func (*AlexaForBusiness) AssociateDeviceWithRoomRequest

func (c *AlexaForBusiness) AssociateDeviceWithRoomRequest(input *AssociateDeviceWithRoomInput) AssociateDeviceWithRoomRequest

AssociateDeviceWithRoomRequest returns a request value for making API operation for Alexa For Business.

Associates a device to a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or a manual sync is required.

// Example sending a request using the AssociateDeviceWithRoomRequest method.
req := client.AssociateDeviceWithRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

func (*AlexaForBusiness) AssociateSkillGroupWithRoomRequest

func (c *AlexaForBusiness) AssociateSkillGroupWithRoomRequest(input *AssociateSkillGroupWithRoomInput) AssociateSkillGroupWithRoomRequest

AssociateSkillGroupWithRoomRequest returns a request value for making API operation for Alexa For Business.

Associates a skill group to a given room. This enables all skills in the associated skill group on all devices in the room.

// Example sending a request using the AssociateSkillGroupWithRoomRequest method.
req := client.AssociateSkillGroupWithRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

func (*AlexaForBusiness) CreateProfileRequest

func (c *AlexaForBusiness) CreateProfileRequest(input *CreateProfileInput) CreateProfileRequest

CreateProfileRequest returns a request value for making API operation for Alexa For Business.

Creates a new room profile with the specified details.

// Example sending a request using the CreateProfileRequest method.
req := client.CreateProfileRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateProfile

func (*AlexaForBusiness) CreateRoomRequest

func (c *AlexaForBusiness) CreateRoomRequest(input *CreateRoomInput) CreateRoomRequest

CreateRoomRequest returns a request value for making API operation for Alexa For Business.

Creates a room with the specified details.

// Example sending a request using the CreateRoomRequest method.
req := client.CreateRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateRoom

func (*AlexaForBusiness) CreateSkillGroupRequest

func (c *AlexaForBusiness) CreateSkillGroupRequest(input *CreateSkillGroupInput) CreateSkillGroupRequest

CreateSkillGroupRequest returns a request value for making API operation for Alexa For Business.

Creates a skill group with a specified name and description.

// Example sending a request using the CreateSkillGroupRequest method.
req := client.CreateSkillGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateSkillGroup

func (*AlexaForBusiness) CreateUserRequest

func (c *AlexaForBusiness) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making API operation for Alexa For Business.

Creates a user.

// Example sending a request using the CreateUserRequest method.
req := client.CreateUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateUser

func (*AlexaForBusiness) DeleteProfileRequest

func (c *AlexaForBusiness) DeleteProfileRequest(input *DeleteProfileInput) DeleteProfileRequest

DeleteProfileRequest returns a request value for making API operation for Alexa For Business.

Deletes a room profile by the profile ARN.

// Example sending a request using the DeleteProfileRequest method.
req := client.DeleteProfileRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteProfile

func (*AlexaForBusiness) DeleteRoomRequest

func (c *AlexaForBusiness) DeleteRoomRequest(input *DeleteRoomInput) DeleteRoomRequest

DeleteRoomRequest returns a request value for making API operation for Alexa For Business.

Deletes a room by the room ARN.

// Example sending a request using the DeleteRoomRequest method.
req := client.DeleteRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoom

func (*AlexaForBusiness) DeleteRoomSkillParameterRequest

func (c *AlexaForBusiness) DeleteRoomSkillParameterRequest(input *DeleteRoomSkillParameterInput) DeleteRoomSkillParameterRequest

DeleteRoomSkillParameterRequest returns a request value for making API operation for Alexa For Business.

Deletes room skill parameter details by room, skill, and parameter key ID.

// Example sending a request using the DeleteRoomSkillParameterRequest method.
req := client.DeleteRoomSkillParameterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

func (*AlexaForBusiness) DeleteSkillGroupRequest

func (c *AlexaForBusiness) DeleteSkillGroupRequest(input *DeleteSkillGroupInput) DeleteSkillGroupRequest

DeleteSkillGroupRequest returns a request value for making API operation for Alexa For Business.

Deletes a skill group by skill group ARN.

// Example sending a request using the DeleteSkillGroupRequest method.
req := client.DeleteSkillGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillGroup

func (*AlexaForBusiness) DeleteUserRequest

func (c *AlexaForBusiness) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making API operation for Alexa For Business.

Deletes a specified user by user ARN and enrollment ARN.

// Example sending a request using the DeleteUserRequest method.
req := client.DeleteUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteUser

func (*AlexaForBusiness) DisassociateDeviceFromRoomRequest

func (c *AlexaForBusiness) DisassociateDeviceFromRoomRequest(input *DisassociateDeviceFromRoomInput) DisassociateDeviceFromRoomRequest

DisassociateDeviceFromRoomRequest returns a request value for making API operation for Alexa For Business.

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

// Example sending a request using the DisassociateDeviceFromRoomRequest method.
req := client.DisassociateDeviceFromRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

func (*AlexaForBusiness) DisassociateSkillGroupFromRoomRequest

func (c *AlexaForBusiness) DisassociateSkillGroupFromRoomRequest(input *DisassociateSkillGroupFromRoomInput) DisassociateSkillGroupFromRoomRequest

DisassociateSkillGroupFromRoomRequest returns a request value for making API operation for Alexa For Business.

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

// Example sending a request using the DisassociateSkillGroupFromRoomRequest method.
req := client.DisassociateSkillGroupFromRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

func (*AlexaForBusiness) GetDeviceRequest

func (c *AlexaForBusiness) GetDeviceRequest(input *GetDeviceInput) GetDeviceRequest

GetDeviceRequest returns a request value for making API operation for Alexa For Business.

Gets the details of a device by device ARN.

// Example sending a request using the GetDeviceRequest method.
req := client.GetDeviceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetDevice

func (*AlexaForBusiness) GetProfileRequest

func (c *AlexaForBusiness) GetProfileRequest(input *GetProfileInput) GetProfileRequest

GetProfileRequest returns a request value for making API operation for Alexa For Business.

Gets the details of a room profile by profile ARN.

// Example sending a request using the GetProfileRequest method.
req := client.GetProfileRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetProfile

func (*AlexaForBusiness) GetRoomRequest

func (c *AlexaForBusiness) GetRoomRequest(input *GetRoomInput) GetRoomRequest

GetRoomRequest returns a request value for making API operation for Alexa For Business.

Gets room details by room ARN.

// Example sending a request using the GetRoomRequest method.
req := client.GetRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoom

func (*AlexaForBusiness) GetRoomSkillParameterRequest

func (c *AlexaForBusiness) GetRoomSkillParameterRequest(input *GetRoomSkillParameterInput) GetRoomSkillParameterRequest

GetRoomSkillParameterRequest returns a request value for making API operation for Alexa For Business.

Gets room skill parameter details by room, skill, and parameter key ARN.

// Example sending a request using the GetRoomSkillParameterRequest method.
req := client.GetRoomSkillParameterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomSkillParameter

func (*AlexaForBusiness) GetSkillGroupRequest

func (c *AlexaForBusiness) GetSkillGroupRequest(input *GetSkillGroupInput) GetSkillGroupRequest

GetSkillGroupRequest returns a request value for making API operation for Alexa For Business.

Gets skill group details by skill group ARN.

// Example sending a request using the GetSkillGroupRequest method.
req := client.GetSkillGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetSkillGroup

func (*AlexaForBusiness) ListSkillsRequest

func (c *AlexaForBusiness) ListSkillsRequest(input *ListSkillsInput) ListSkillsRequest

ListSkillsRequest returns a request value for making API operation for Alexa For Business.

Lists all enabled skills in a specific skill group.

// Example sending a request using the ListSkillsRequest method.
req := client.ListSkillsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkills

func (*AlexaForBusiness) ListTagsRequest

func (c *AlexaForBusiness) ListTagsRequest(input *ListTagsInput) ListTagsRequest

ListTagsRequest returns a request value for making API operation for Alexa For Business.

Lists all tags for a specific resource.

// Example sending a request using the ListTagsRequest method.
req := client.ListTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListTags

func (*AlexaForBusiness) PutRoomSkillParameterRequest

func (c *AlexaForBusiness) PutRoomSkillParameterRequest(input *PutRoomSkillParameterInput) PutRoomSkillParameterRequest

PutRoomSkillParameterRequest returns a request value for making API operation for Alexa For Business.

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

// Example sending a request using the PutRoomSkillParameterRequest method.
req := client.PutRoomSkillParameterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutRoomSkillParameter

func (*AlexaForBusiness) ResolveRoomRequest

func (c *AlexaForBusiness) ResolveRoomRequest(input *ResolveRoomInput) ResolveRoomRequest

ResolveRoomRequest returns a request value for making API operation for Alexa For Business.

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

// Example sending a request using the ResolveRoomRequest method.
req := client.ResolveRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ResolveRoom

func (*AlexaForBusiness) RevokeInvitationRequest

func (c *AlexaForBusiness) RevokeInvitationRequest(input *RevokeInvitationInput) RevokeInvitationRequest

RevokeInvitationRequest returns a request value for making API operation for Alexa For Business.

Revokes an invitation and invalidates the enrollment URL.

// Example sending a request using the RevokeInvitationRequest method.
req := client.RevokeInvitationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RevokeInvitation

func (*AlexaForBusiness) SearchDevicesRequest

func (c *AlexaForBusiness) SearchDevicesRequest(input *SearchDevicesInput) SearchDevicesRequest

SearchDevicesRequest returns a request value for making API operation for Alexa For Business.

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

// Example sending a request using the SearchDevicesRequest method.
req := client.SearchDevicesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchDevices

func (*AlexaForBusiness) SearchProfilesRequest

func (c *AlexaForBusiness) SearchProfilesRequest(input *SearchProfilesInput) SearchProfilesRequest

SearchProfilesRequest returns a request value for making API operation for Alexa For Business.

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

// Example sending a request using the SearchProfilesRequest method.
req := client.SearchProfilesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchProfiles

func (*AlexaForBusiness) SearchRoomsRequest

func (c *AlexaForBusiness) SearchRoomsRequest(input *SearchRoomsInput) SearchRoomsRequest

SearchRoomsRequest returns a request value for making API operation for Alexa For Business.

Searches rooms and lists the ones that meet a set of filter and sort criteria.

// Example sending a request using the SearchRoomsRequest method.
req := client.SearchRoomsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchRooms

func (*AlexaForBusiness) SearchSkillGroupsRequest

func (c *AlexaForBusiness) SearchSkillGroupsRequest(input *SearchSkillGroupsInput) SearchSkillGroupsRequest

SearchSkillGroupsRequest returns a request value for making API operation for Alexa For Business.

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

// Example sending a request using the SearchSkillGroupsRequest method.
req := client.SearchSkillGroupsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchSkillGroups

func (*AlexaForBusiness) SearchUsersRequest

func (c *AlexaForBusiness) SearchUsersRequest(input *SearchUsersInput) SearchUsersRequest

SearchUsersRequest returns a request value for making API operation for Alexa For Business.

Searches users and lists the ones that meet a set of filter and sort criteria.

// Example sending a request using the SearchUsersRequest method.
req := client.SearchUsersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchUsers

func (*AlexaForBusiness) SendInvitationRequest

func (c *AlexaForBusiness) SendInvitationRequest(input *SendInvitationInput) SendInvitationRequest

SendInvitationRequest returns a request value for making API operation for Alexa For Business.

Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.

// Example sending a request using the SendInvitationRequest method.
req := client.SendInvitationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendInvitation

func (*AlexaForBusiness) StartDeviceSyncRequest

func (c *AlexaForBusiness) StartDeviceSyncRequest(input *StartDeviceSyncInput) StartDeviceSyncRequest

StartDeviceSyncRequest returns a request value for making API operation for Alexa For Business.

Resets a device and its account to the known default settings by clearing all information and settings set by previous users.

// Example sending a request using the StartDeviceSyncRequest method.
req := client.StartDeviceSyncRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartDeviceSync

func (*AlexaForBusiness) TagResourceRequest

func (c *AlexaForBusiness) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Alexa For Business.

Adds metadata tags to a specified resource.

// Example sending a request using the TagResourceRequest method.
req := client.TagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/TagResource

func (*AlexaForBusiness) UntagResourceRequest

func (c *AlexaForBusiness) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Alexa For Business.

Removes metadata tags from a specified resource.

// Example sending a request using the UntagResourceRequest method.
req := client.UntagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UntagResource

func (*AlexaForBusiness) UpdateDeviceRequest

func (c *AlexaForBusiness) UpdateDeviceRequest(input *UpdateDeviceInput) UpdateDeviceRequest

UpdateDeviceRequest returns a request value for making API operation for Alexa For Business.

Updates the device name by device ARN.

// Example sending a request using the UpdateDeviceRequest method.
req := client.UpdateDeviceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateDevice

func (*AlexaForBusiness) UpdateProfileRequest

func (c *AlexaForBusiness) UpdateProfileRequest(input *UpdateProfileInput) UpdateProfileRequest

UpdateProfileRequest returns a request value for making API operation for Alexa For Business.

Updates an existing room profile by room profile ARN.

// Example sending a request using the UpdateProfileRequest method.
req := client.UpdateProfileRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateProfile

func (*AlexaForBusiness) UpdateRoomRequest

func (c *AlexaForBusiness) UpdateRoomRequest(input *UpdateRoomInput) UpdateRoomRequest

UpdateRoomRequest returns a request value for making API operation for Alexa For Business.

Updates room details by room ARN.

// Example sending a request using the UpdateRoomRequest method.
req := client.UpdateRoomRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateRoom

func (*AlexaForBusiness) UpdateSkillGroupRequest

func (c *AlexaForBusiness) UpdateSkillGroupRequest(input *UpdateSkillGroupInput) UpdateSkillGroupRequest

UpdateSkillGroupRequest returns a request value for making API operation for Alexa For Business.

Updates skill group details by skill group ARN.

// Example sending a request using the UpdateSkillGroupRequest method.
req := client.UpdateSkillGroupRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateSkillGroup

type AssociateDeviceWithRoomInput

type AssociateDeviceWithRoomInput struct {

	// The ARN of the device to associate to a room. Required.
	DeviceArn *string `type:"string"`

	// The ARN of the room with which to associate the device. Required.
	RoomArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateDeviceWithRoomRequest

func (AssociateDeviceWithRoomInput) GoString

func (s AssociateDeviceWithRoomInput) GoString() string

GoString returns the string representation

func (AssociateDeviceWithRoomInput) String

String returns the string representation

type AssociateDeviceWithRoomOutput

type AssociateDeviceWithRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateDeviceWithRoomResponse

func (AssociateDeviceWithRoomOutput) GoString

GoString returns the string representation

func (AssociateDeviceWithRoomOutput) SDKResponseMetadata

func (s AssociateDeviceWithRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (AssociateDeviceWithRoomOutput) String

String returns the string representation

type AssociateDeviceWithRoomRequest

type AssociateDeviceWithRoomRequest struct {
	*aws.Request
	Input *AssociateDeviceWithRoomInput
	Copy  func(*AssociateDeviceWithRoomInput) AssociateDeviceWithRoomRequest
}

AssociateDeviceWithRoomRequest is a API request type for the AssociateDeviceWithRoom API operation.

func (AssociateDeviceWithRoomRequest) Send

Send marshals and sends the AssociateDeviceWithRoom API request.

type AssociateSkillGroupWithRoomInput

type AssociateSkillGroupWithRoomInput struct {

	// The ARN of the room with which to associate the skill group. Required.
	RoomArn *string `type:"string"`

	// The ARN of the skill group to associate with a room. Required.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoomRequest

func (AssociateSkillGroupWithRoomInput) GoString

GoString returns the string representation

func (AssociateSkillGroupWithRoomInput) String

String returns the string representation

type AssociateSkillGroupWithRoomOutput

type AssociateSkillGroupWithRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoomResponse

func (AssociateSkillGroupWithRoomOutput) GoString

GoString returns the string representation

func (AssociateSkillGroupWithRoomOutput) SDKResponseMetadata

func (s AssociateSkillGroupWithRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (AssociateSkillGroupWithRoomOutput) String

String returns the string representation

type AssociateSkillGroupWithRoomRequest

type AssociateSkillGroupWithRoomRequest struct {
	*aws.Request
	Input *AssociateSkillGroupWithRoomInput
	Copy  func(*AssociateSkillGroupWithRoomInput) AssociateSkillGroupWithRoomRequest
}

AssociateSkillGroupWithRoomRequest is a API request type for the AssociateSkillGroupWithRoom API operation.

func (AssociateSkillGroupWithRoomRequest) Send

Send marshals and sends the AssociateSkillGroupWithRoom API request.

type CreateProfileInput

type CreateProfileInput struct {

	// The valid address for the room.
	//
	// Address is a required field
	Address *string `min:"1" type:"string" required:"true"`

	// The user-specified token that is used during the creation of a profile.
	ClientRequestToken *string `min:"10" type:"string" idempotencyToken:"true"`

	// The distance unit to be used by devices in the profile.
	//
	// DistanceUnit is a required field
	DistanceUnit DistanceUnit `type:"string" required:"true" enum:"true"`

	// The maximum volume limit for a room profile.
	MaxVolumeLimit *int64 `type:"integer"`

	// Whether PSTN calling is enabled.
	PSTNEnabled *bool `type:"boolean"`

	// The name of a room profile.
	//
	// ProfileName is a required field
	ProfileName *string `min:"1" type:"string" required:"true"`

	// Whether room profile setup is enabled.
	SetupModeDisabled *bool `type:"boolean"`

	// The temperature unit to be used by devices in the profile.
	//
	// TemperatureUnit is a required field
	TemperatureUnit TemperatureUnit `type:"string" required:"true" enum:"true"`

	// The time zone used by a room profile.
	//
	// Timezone is a required field
	Timezone *string `min:"1" type:"string" required:"true"`

	// A wake word for Alexa, Echo, Amazon, or a computer.
	//
	// WakeWord is a required field
	WakeWord WakeWord `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateProfileRequest

func (CreateProfileInput) GoString

func (s CreateProfileInput) GoString() string

GoString returns the string representation

func (CreateProfileInput) String

func (s CreateProfileInput) String() string

String returns the string representation

func (*CreateProfileInput) Validate

func (s *CreateProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProfileOutput

type CreateProfileOutput struct {

	// The ARN of the newly created room profile in the response.
	ProfileArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateProfileResponse

func (CreateProfileOutput) GoString

func (s CreateProfileOutput) GoString() string

GoString returns the string representation

func (CreateProfileOutput) SDKResponseMetadata

func (s CreateProfileOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateProfileOutput) String

func (s CreateProfileOutput) String() string

String returns the string representation

type CreateProfileRequest

type CreateProfileRequest struct {
	*aws.Request
	Input *CreateProfileInput
	Copy  func(*CreateProfileInput) CreateProfileRequest
}

CreateProfileRequest is a API request type for the CreateProfile API operation.

func (CreateProfileRequest) Send

Send marshals and sends the CreateProfile API request.

type CreateRoomInput

type CreateRoomInput struct {

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string `min:"10" type:"string" idempotencyToken:"true"`

	// The description for the room.
	Description *string `min:"1" type:"string"`

	// The profile ARN for the room.
	ProfileArn *string `type:"string"`

	// The calendar ARN for the room.
	ProviderCalendarId *string `type:"string"`

	// The name for the room.
	//
	// RoomName is a required field
	RoomName *string `min:"1" type:"string" required:"true"`

	// The tags for the room.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateRoomRequest

func (CreateRoomInput) GoString

func (s CreateRoomInput) GoString() string

GoString returns the string representation

func (CreateRoomInput) String

func (s CreateRoomInput) String() string

String returns the string representation

func (*CreateRoomInput) Validate

func (s *CreateRoomInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRoomOutput

type CreateRoomOutput struct {

	// The ARN of the newly created room in the response.
	RoomArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateRoomResponse

func (CreateRoomOutput) GoString

func (s CreateRoomOutput) GoString() string

GoString returns the string representation

func (CreateRoomOutput) SDKResponseMetadata

func (s CreateRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateRoomOutput) String

func (s CreateRoomOutput) String() string

String returns the string representation

type CreateRoomRequest

type CreateRoomRequest struct {
	*aws.Request
	Input *CreateRoomInput
	Copy  func(*CreateRoomInput) CreateRoomRequest
}

CreateRoomRequest is a API request type for the CreateRoom API operation.

func (CreateRoomRequest) Send

Send marshals and sends the CreateRoom API request.

type CreateSkillGroupInput

type CreateSkillGroupInput struct {

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string `min:"10" type:"string" idempotencyToken:"true"`

	// The description for the skill group.
	Description *string `min:"1" type:"string"`

	// The name for the skill group.
	//
	// SkillGroupName is a required field
	SkillGroupName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateSkillGroupRequest

func (CreateSkillGroupInput) GoString

func (s CreateSkillGroupInput) GoString() string

GoString returns the string representation

func (CreateSkillGroupInput) String

func (s CreateSkillGroupInput) String() string

String returns the string representation

func (*CreateSkillGroupInput) Validate

func (s *CreateSkillGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSkillGroupOutput

type CreateSkillGroupOutput struct {

	// The ARN of the newly created skill group in the response.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateSkillGroupResponse

func (CreateSkillGroupOutput) GoString

func (s CreateSkillGroupOutput) GoString() string

GoString returns the string representation

func (CreateSkillGroupOutput) SDKResponseMetadata

func (s CreateSkillGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateSkillGroupOutput) String

func (s CreateSkillGroupOutput) String() string

String returns the string representation

type CreateSkillGroupRequest

type CreateSkillGroupRequest struct {
	*aws.Request
	Input *CreateSkillGroupInput
	Copy  func(*CreateSkillGroupInput) CreateSkillGroupRequest
}

CreateSkillGroupRequest is a API request type for the CreateSkillGroup API operation.

func (CreateSkillGroupRequest) Send

Send marshals and sends the CreateSkillGroup API request.

type CreateUserInput

type CreateUserInput struct {

	// A unique, user-specified identifier for this request that ensures idempotency.
	ClientRequestToken *string `min:"10" type:"string" idempotencyToken:"true"`

	// The email address for the user.
	Email *string `min:"1" type:"string"`

	// The first name for the user.
	FirstName *string `type:"string"`

	// The last name for the user.
	LastName *string `type:"string"`

	// The tags for the user.
	Tags []Tag `type:"list"`

	// The ARN for the user.
	//
	// UserId is a required field
	UserId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateUserRequest

func (CreateUserInput) GoString

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (CreateUserInput) String

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput

type CreateUserOutput struct {

	// The ARN of the newly created user in the response.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateUserResponse

func (CreateUserOutput) GoString

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (CreateUserOutput) SDKResponseMetadata

func (s CreateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateUserOutput) String

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is a API request type for the CreateUser API operation.

func (CreateUserRequest) Send

Send marshals and sends the CreateUser API request.

type DeleteProfileInput

type DeleteProfileInput struct {

	// The ARN of the room profile to delete. Required.
	ProfileArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteProfileRequest

func (DeleteProfileInput) GoString

func (s DeleteProfileInput) GoString() string

GoString returns the string representation

func (DeleteProfileInput) String

func (s DeleteProfileInput) String() string

String returns the string representation

type DeleteProfileOutput

type DeleteProfileOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteProfileResponse

func (DeleteProfileOutput) GoString

func (s DeleteProfileOutput) GoString() string

GoString returns the string representation

func (DeleteProfileOutput) SDKResponseMetadata

func (s DeleteProfileOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteProfileOutput) String

func (s DeleteProfileOutput) String() string

String returns the string representation

type DeleteProfileRequest

type DeleteProfileRequest struct {
	*aws.Request
	Input *DeleteProfileInput
	Copy  func(*DeleteProfileInput) DeleteProfileRequest
}

DeleteProfileRequest is a API request type for the DeleteProfile API operation.

func (DeleteProfileRequest) Send

Send marshals and sends the DeleteProfile API request.

type DeleteRoomInput

type DeleteRoomInput struct {

	// The ARN of the room to delete. Required.
	RoomArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomRequest

func (DeleteRoomInput) GoString

func (s DeleteRoomInput) GoString() string

GoString returns the string representation

func (DeleteRoomInput) String

func (s DeleteRoomInput) String() string

String returns the string representation

type DeleteRoomOutput

type DeleteRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomResponse

func (DeleteRoomOutput) GoString

func (s DeleteRoomOutput) GoString() string

GoString returns the string representation

func (DeleteRoomOutput) SDKResponseMetadata

func (s DeleteRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteRoomOutput) String

func (s DeleteRoomOutput) String() string

String returns the string representation

type DeleteRoomRequest

type DeleteRoomRequest struct {
	*aws.Request
	Input *DeleteRoomInput
	Copy  func(*DeleteRoomInput) DeleteRoomRequest
}

DeleteRoomRequest is a API request type for the DeleteRoom API operation.

func (DeleteRoomRequest) Send

Send marshals and sends the DeleteRoom API request.

type DeleteRoomSkillParameterInput

type DeleteRoomSkillParameterInput struct {

	// The room skill parameter key for which to remove details.
	//
	// ParameterKey is a required field
	ParameterKey *string `min:"1" type:"string" required:"true"`

	// The ARN of the room from which to remove the room skill parameter details.
	RoomArn *string `type:"string"`

	// The ID of the skill from which to remove the room skill parameter details.
	//
	// SkillId is a required field
	SkillId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomSkillParameterRequest

func (DeleteRoomSkillParameterInput) GoString

GoString returns the string representation

func (DeleteRoomSkillParameterInput) String

String returns the string representation

func (*DeleteRoomSkillParameterInput) Validate

func (s *DeleteRoomSkillParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRoomSkillParameterOutput

type DeleteRoomSkillParameterOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomSkillParameterResponse

func (DeleteRoomSkillParameterOutput) GoString

GoString returns the string representation

func (DeleteRoomSkillParameterOutput) SDKResponseMetadata

func (s DeleteRoomSkillParameterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteRoomSkillParameterOutput) String

String returns the string representation

type DeleteRoomSkillParameterRequest

type DeleteRoomSkillParameterRequest struct {
	*aws.Request
	Input *DeleteRoomSkillParameterInput
	Copy  func(*DeleteRoomSkillParameterInput) DeleteRoomSkillParameterRequest
}

DeleteRoomSkillParameterRequest is a API request type for the DeleteRoomSkillParameter API operation.

func (DeleteRoomSkillParameterRequest) Send

Send marshals and sends the DeleteRoomSkillParameter API request.

type DeleteSkillGroupInput

type DeleteSkillGroupInput struct {

	// The ARN of the skill group to delete. Required.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillGroupRequest

func (DeleteSkillGroupInput) GoString

func (s DeleteSkillGroupInput) GoString() string

GoString returns the string representation

func (DeleteSkillGroupInput) String

func (s DeleteSkillGroupInput) String() string

String returns the string representation

type DeleteSkillGroupOutput

type DeleteSkillGroupOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillGroupResponse

func (DeleteSkillGroupOutput) GoString

func (s DeleteSkillGroupOutput) GoString() string

GoString returns the string representation

func (DeleteSkillGroupOutput) SDKResponseMetadata

func (s DeleteSkillGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteSkillGroupOutput) String

func (s DeleteSkillGroupOutput) String() string

String returns the string representation

type DeleteSkillGroupRequest

type DeleteSkillGroupRequest struct {
	*aws.Request
	Input *DeleteSkillGroupInput
	Copy  func(*DeleteSkillGroupInput) DeleteSkillGroupRequest
}

DeleteSkillGroupRequest is a API request type for the DeleteSkillGroup API operation.

func (DeleteSkillGroupRequest) Send

Send marshals and sends the DeleteSkillGroup API request.

type DeleteUserInput

type DeleteUserInput struct {

	// The ARN of the user's enrollment in the organization. Required.
	//
	// EnrollmentId is a required field
	EnrollmentId *string `type:"string" required:"true"`

	// The ARN of the user to delete in the organization. Required.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteUserRequest

func (DeleteUserInput) GoString

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (DeleteUserInput) String

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput

type DeleteUserOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteUserResponse

func (DeleteUserOutput) GoString

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) SDKResponseMetadata

func (s DeleteUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUserOutput) String

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is a API request type for the DeleteUser API operation.

func (DeleteUserRequest) Send

Send marshals and sends the DeleteUser API request.

type Device

type Device struct {

	// The ARN of a device.
	DeviceArn *string `type:"string"`

	// The name of a device.
	DeviceName *string `min:"2" type:"string"`

	// The serial number of a device.
	DeviceSerialNumber *string `type:"string"`

	// The status of a device. If the status is not READY, check the DeviceStatusInfo
	// for details.
	DeviceStatus DeviceStatus `type:"string" enum:"true"`

	// Detailed information about a device's status.
	DeviceStatusInfo *DeviceStatusInfo `type:"structure"`

	// The type of a device.
	DeviceType *string `type:"string"`

	// The MAC address of a device.
	MacAddress *string `type:"string"`

	// The room ARN of a device.
	RoomArn *string `type:"string"`

	// The software version of a device.
	SoftwareVersion *string `type:"string"`
	// contains filtered or unexported fields
}

A device with attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Device

func (Device) GoString

func (s Device) GoString() string

GoString returns the string representation

func (Device) String

func (s Device) String() string

String returns the string representation

type DeviceData

type DeviceData struct {

	// The ARN of a device.
	DeviceArn *string `type:"string"`

	// The name of a device.
	DeviceName *string `min:"2" type:"string"`

	// The serial number of a device.
	DeviceSerialNumber *string `type:"string"`

	// The status of a device.
	DeviceStatus DeviceStatus `type:"string" enum:"true"`

	// Detailed information about a device's status.
	DeviceStatusInfo *DeviceStatusInfo `type:"structure"`

	// The type of a device.
	DeviceType *string `type:"string"`

	// The MAC address of a device.
	MacAddress *string `type:"string"`

	// The room ARN associated with a device.
	RoomArn *string `type:"string"`

	// The name of the room associated with a device.
	RoomName *string `min:"1" type:"string"`

	// The software version of a device.
	SoftwareVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Device attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeviceData

func (DeviceData) GoString

func (s DeviceData) GoString() string

GoString returns the string representation

func (DeviceData) String

func (s DeviceData) String() string

String returns the string representation

type DeviceStatus

type DeviceStatus string
const (
	DeviceStatusReady      DeviceStatus = "READY"
	DeviceStatusPending    DeviceStatus = "PENDING"
	DeviceStatusWasOffline DeviceStatus = "WAS_OFFLINE"
)

Enum values for DeviceStatus

func (DeviceStatus) MarshalValue added in v0.3.0

func (enum DeviceStatus) MarshalValue() (string, error)

func (DeviceStatus) MarshalValueBuf added in v0.3.0

func (enum DeviceStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DeviceStatusDetail added in v0.3.0

type DeviceStatusDetail struct {

	// The device status detail code.
	Code DeviceStatusDetailCode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of a device’s status. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeviceStatusDetail

func (DeviceStatusDetail) GoString added in v0.3.0

func (s DeviceStatusDetail) GoString() string

GoString returns the string representation

func (DeviceStatusDetail) String added in v0.3.0

func (s DeviceStatusDetail) String() string

String returns the string representation

type DeviceStatusDetailCode added in v0.3.0

type DeviceStatusDetailCode string
const (
	DeviceStatusDetailCodeDeviceSoftwareUpdateNeeded DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"
	DeviceStatusDetailCodeDeviceWasOffline           DeviceStatusDetailCode = "DEVICE_WAS_OFFLINE"
)

Enum values for DeviceStatusDetailCode

func (DeviceStatusDetailCode) MarshalValue added in v0.3.0

func (enum DeviceStatusDetailCode) MarshalValue() (string, error)

func (DeviceStatusDetailCode) MarshalValueBuf added in v0.3.0

func (enum DeviceStatusDetailCode) MarshalValueBuf(b []byte) ([]byte, error)

type DeviceStatusInfo added in v0.3.0

type DeviceStatusInfo struct {

	// One or more device status detail descriptions.
	DeviceStatusDetails []DeviceStatusDetail `type:"list"`
	// contains filtered or unexported fields
}

Detailed information about a device's status. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeviceStatusInfo

func (DeviceStatusInfo) GoString added in v0.3.0

func (s DeviceStatusInfo) GoString() string

GoString returns the string representation

func (DeviceStatusInfo) String added in v0.3.0

func (s DeviceStatusInfo) String() string

String returns the string representation

type DisassociateDeviceFromRoomInput

type DisassociateDeviceFromRoomInput struct {

	// The ARN of the device to disassociate from a room. Required.
	DeviceArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoomRequest

func (DisassociateDeviceFromRoomInput) GoString

GoString returns the string representation

func (DisassociateDeviceFromRoomInput) String

String returns the string representation

type DisassociateDeviceFromRoomOutput

type DisassociateDeviceFromRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoomResponse

func (DisassociateDeviceFromRoomOutput) GoString

GoString returns the string representation

func (DisassociateDeviceFromRoomOutput) SDKResponseMetadata

func (s DisassociateDeviceFromRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DisassociateDeviceFromRoomOutput) String

String returns the string representation

type DisassociateDeviceFromRoomRequest

type DisassociateDeviceFromRoomRequest struct {
	*aws.Request
	Input *DisassociateDeviceFromRoomInput
	Copy  func(*DisassociateDeviceFromRoomInput) DisassociateDeviceFromRoomRequest
}

DisassociateDeviceFromRoomRequest is a API request type for the DisassociateDeviceFromRoom API operation.

func (DisassociateDeviceFromRoomRequest) Send

Send marshals and sends the DisassociateDeviceFromRoom API request.

type DisassociateSkillGroupFromRoomInput

type DisassociateSkillGroupFromRoomInput struct {

	// The ARN of the room from which the skill group is to be disassociated. Required.
	RoomArn *string `type:"string"`

	// The ARN of the skill group to disassociate from a room. Required.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoomRequest

func (DisassociateSkillGroupFromRoomInput) GoString

GoString returns the string representation

func (DisassociateSkillGroupFromRoomInput) String

String returns the string representation

type DisassociateSkillGroupFromRoomOutput

type DisassociateSkillGroupFromRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoomResponse

func (DisassociateSkillGroupFromRoomOutput) GoString

GoString returns the string representation

func (DisassociateSkillGroupFromRoomOutput) SDKResponseMetadata

func (s DisassociateSkillGroupFromRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DisassociateSkillGroupFromRoomOutput) String

String returns the string representation

type DisassociateSkillGroupFromRoomRequest

type DisassociateSkillGroupFromRoomRequest struct {
	*aws.Request
	Input *DisassociateSkillGroupFromRoomInput
	Copy  func(*DisassociateSkillGroupFromRoomInput) DisassociateSkillGroupFromRoomRequest
}

DisassociateSkillGroupFromRoomRequest is a API request type for the DisassociateSkillGroupFromRoom API operation.

func (DisassociateSkillGroupFromRoomRequest) Send

Send marshals and sends the DisassociateSkillGroupFromRoom API request.

type DistanceUnit

type DistanceUnit string
const (
	DistanceUnitMetric   DistanceUnit = "METRIC"
	DistanceUnitImperial DistanceUnit = "IMPERIAL"
)

Enum values for DistanceUnit

func (DistanceUnit) MarshalValue added in v0.3.0

func (enum DistanceUnit) MarshalValue() (string, error)

func (DistanceUnit) MarshalValueBuf added in v0.3.0

func (enum DistanceUnit) MarshalValueBuf(b []byte) ([]byte, error)

type EnrollmentStatus

type EnrollmentStatus string
const (
	EnrollmentStatusInitialized   EnrollmentStatus = "INITIALIZED"
	EnrollmentStatusPending       EnrollmentStatus = "PENDING"
	EnrollmentStatusRegistered    EnrollmentStatus = "REGISTERED"
	EnrollmentStatusDeregistering EnrollmentStatus = "DEREGISTERING"
)

Enum values for EnrollmentStatus

func (EnrollmentStatus) MarshalValue added in v0.3.0

func (enum EnrollmentStatus) MarshalValue() (string, error)

func (EnrollmentStatus) MarshalValueBuf added in v0.3.0

func (enum EnrollmentStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Feature

type Feature string
const (
	FeatureBluetooth     Feature = "BLUETOOTH"
	FeatureVolume        Feature = "VOLUME"
	FeatureNotifications Feature = "NOTIFICATIONS"
	FeatureLists         Feature = "LISTS"
	FeatureSkills        Feature = "SKILLS"
	FeatureAll           Feature = "ALL"
)

Enum values for Feature

func (Feature) MarshalValue added in v0.3.0

func (enum Feature) MarshalValue() (string, error)

func (Feature) MarshalValueBuf added in v0.3.0

func (enum Feature) MarshalValueBuf(b []byte) ([]byte, error)

type Filter

type Filter struct {

	// The key of a filter.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The values of a filter.
	//
	// Values is a required field
	Values []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Filter

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation

func (Filter) String

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeviceInput

type GetDeviceInput struct {

	// The ARN of the device for which to request details. Required.
	DeviceArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetDeviceRequest

func (GetDeviceInput) GoString

func (s GetDeviceInput) GoString() string

GoString returns the string representation

func (GetDeviceInput) String

func (s GetDeviceInput) String() string

String returns the string representation

type GetDeviceOutput

type GetDeviceOutput struct {

	// The details of the device requested. Required.
	Device *Device `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetDeviceResponse

func (GetDeviceOutput) GoString

func (s GetDeviceOutput) GoString() string

GoString returns the string representation

func (GetDeviceOutput) SDKResponseMetadata

func (s GetDeviceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetDeviceOutput) String

func (s GetDeviceOutput) String() string

String returns the string representation

type GetDeviceRequest

type GetDeviceRequest struct {
	*aws.Request
	Input *GetDeviceInput
	Copy  func(*GetDeviceInput) GetDeviceRequest
}

GetDeviceRequest is a API request type for the GetDevice API operation.

func (GetDeviceRequest) Send

func (r GetDeviceRequest) Send() (*GetDeviceOutput, error)

Send marshals and sends the GetDevice API request.

type GetProfileInput

type GetProfileInput struct {

	// The ARN of the room profile for which to request details. Required.
	ProfileArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetProfileRequest

func (GetProfileInput) GoString

func (s GetProfileInput) GoString() string

GoString returns the string representation

func (GetProfileInput) String

func (s GetProfileInput) String() string

String returns the string representation

type GetProfileOutput

type GetProfileOutput struct {

	// The details of the room profile requested. Required.
	Profile *Profile `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetProfileResponse

func (GetProfileOutput) GoString

func (s GetProfileOutput) GoString() string

GoString returns the string representation

func (GetProfileOutput) SDKResponseMetadata

func (s GetProfileOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetProfileOutput) String

func (s GetProfileOutput) String() string

String returns the string representation

type GetProfileRequest

type GetProfileRequest struct {
	*aws.Request
	Input *GetProfileInput
	Copy  func(*GetProfileInput) GetProfileRequest
}

GetProfileRequest is a API request type for the GetProfile API operation.

func (GetProfileRequest) Send

Send marshals and sends the GetProfile API request.

type GetRoomInput

type GetRoomInput struct {

	// The ARN of the room for which to request details. Required.
	RoomArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomRequest

func (GetRoomInput) GoString

func (s GetRoomInput) GoString() string

GoString returns the string representation

func (GetRoomInput) String

func (s GetRoomInput) String() string

String returns the string representation

type GetRoomOutput

type GetRoomOutput struct {

	// The details of the room requested.
	Room *Room `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomResponse

func (GetRoomOutput) GoString

func (s GetRoomOutput) GoString() string

GoString returns the string representation

func (GetRoomOutput) SDKResponseMetadata

func (s GetRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetRoomOutput) String

func (s GetRoomOutput) String() string

String returns the string representation

type GetRoomRequest

type GetRoomRequest struct {
	*aws.Request
	Input *GetRoomInput
	Copy  func(*GetRoomInput) GetRoomRequest
}

GetRoomRequest is a API request type for the GetRoom API operation.

func (GetRoomRequest) Send

func (r GetRoomRequest) Send() (*GetRoomOutput, error)

Send marshals and sends the GetRoom API request.

type GetRoomSkillParameterInput

type GetRoomSkillParameterInput struct {

	// The room skill parameter key for which to get details. Required.
	//
	// ParameterKey is a required field
	ParameterKey *string `min:"1" type:"string" required:"true"`

	// The ARN of the room from which to get the room skill parameter details.
	RoomArn *string `type:"string"`

	// The ARN of the skill from which to get the room skill parameter details.
	// Required.
	//
	// SkillId is a required field
	SkillId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomSkillParameterRequest

func (GetRoomSkillParameterInput) GoString

func (s GetRoomSkillParameterInput) GoString() string

GoString returns the string representation

func (GetRoomSkillParameterInput) String

String returns the string representation

func (*GetRoomSkillParameterInput) Validate

func (s *GetRoomSkillParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRoomSkillParameterOutput

type GetRoomSkillParameterOutput struct {

	// The details of the room skill parameter requested. Required.
	RoomSkillParameter *RoomSkillParameter `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomSkillParameterResponse

func (GetRoomSkillParameterOutput) GoString

func (s GetRoomSkillParameterOutput) GoString() string

GoString returns the string representation

func (GetRoomSkillParameterOutput) SDKResponseMetadata

func (s GetRoomSkillParameterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetRoomSkillParameterOutput) String

String returns the string representation

type GetRoomSkillParameterRequest

type GetRoomSkillParameterRequest struct {
	*aws.Request
	Input *GetRoomSkillParameterInput
	Copy  func(*GetRoomSkillParameterInput) GetRoomSkillParameterRequest
}

GetRoomSkillParameterRequest is a API request type for the GetRoomSkillParameter API operation.

func (GetRoomSkillParameterRequest) Send

Send marshals and sends the GetRoomSkillParameter API request.

type GetSkillGroupInput

type GetSkillGroupInput struct {

	// The ARN of the skill group for which to get details. Required.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetSkillGroupRequest

func (GetSkillGroupInput) GoString

func (s GetSkillGroupInput) GoString() string

GoString returns the string representation

func (GetSkillGroupInput) String

func (s GetSkillGroupInput) String() string

String returns the string representation

type GetSkillGroupOutput

type GetSkillGroupOutput struct {

	// The details of the skill group requested. Required.
	SkillGroup *SkillGroup `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetSkillGroupResponse

func (GetSkillGroupOutput) GoString

func (s GetSkillGroupOutput) GoString() string

GoString returns the string representation

func (GetSkillGroupOutput) SDKResponseMetadata

func (s GetSkillGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetSkillGroupOutput) String

func (s GetSkillGroupOutput) String() string

String returns the string representation

type GetSkillGroupRequest

type GetSkillGroupRequest struct {
	*aws.Request
	Input *GetSkillGroupInput
	Copy  func(*GetSkillGroupInput) GetSkillGroupRequest
}

GetSkillGroupRequest is a API request type for the GetSkillGroup API operation.

func (GetSkillGroupRequest) Send

Send marshals and sends the GetSkillGroup API request.

type ListSkillsInput

type ListSkillsInput struct {

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The ARN of the skill group for which to list enabled skills. Required.
	SkillGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsRequest

func (ListSkillsInput) GoString

func (s ListSkillsInput) GoString() string

GoString returns the string representation

func (ListSkillsInput) String

func (s ListSkillsInput) String() string

String returns the string representation

func (*ListSkillsInput) Validate

func (s *ListSkillsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSkillsOutput

type ListSkillsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The list of enabled skills requested. Required.
	SkillSummaries []SkillSummary `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsResponse

func (ListSkillsOutput) GoString

func (s ListSkillsOutput) GoString() string

GoString returns the string representation

func (ListSkillsOutput) SDKResponseMetadata

func (s ListSkillsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListSkillsOutput) String

func (s ListSkillsOutput) String() string

String returns the string representation

type ListSkillsPager added in v0.3.0

type ListSkillsPager struct {
	aws.Pager
}

ListSkillsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListSkillsPager) CurrentPage added in v0.3.0

func (p *ListSkillsPager) CurrentPage() *ListSkillsOutput

type ListSkillsRequest

type ListSkillsRequest struct {
	*aws.Request
	Input *ListSkillsInput
	Copy  func(*ListSkillsInput) ListSkillsRequest
}

ListSkillsRequest is a API request type for the ListSkills API operation.

func (*ListSkillsRequest) Paginate added in v0.3.0

func (p *ListSkillsRequest) Paginate(opts ...aws.Option) ListSkillsPager

Paginate pages iterates over the pages of a ListSkillsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListSkills operation.
		req := client.ListSkillsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListSkillsRequest) Send

Send marshals and sends the ListSkills API request.

type ListTagsInput

type ListTagsInput struct {

	// The ARN of the specific resource for which to list tags. Required.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListTagsRequest

func (ListTagsInput) GoString

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsOutput

type ListTagsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The list of tags requested for the specific resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListTagsResponse

func (ListTagsOutput) GoString

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (ListTagsOutput) SDKResponseMetadata

func (s ListTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

type ListTagsPager added in v0.3.0

type ListTagsPager struct {
	aws.Pager
}

ListTagsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListTagsPager) CurrentPage added in v0.3.0

func (p *ListTagsPager) CurrentPage() *ListTagsOutput

type ListTagsRequest

type ListTagsRequest struct {
	*aws.Request
	Input *ListTagsInput
	Copy  func(*ListTagsInput) ListTagsRequest
}

ListTagsRequest is a API request type for the ListTags API operation.

func (*ListTagsRequest) Paginate added in v0.3.0

func (p *ListTagsRequest) Paginate(opts ...aws.Option) ListTagsPager

Paginate pages iterates over the pages of a ListTagsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a ListTags operation.
		req := client.ListTagsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListTagsRequest) Send

func (r ListTagsRequest) Send() (*ListTagsOutput, error)

Send marshals and sends the ListTags API request.

type Profile

type Profile struct {

	// The address of a room profile.
	Address *string `min:"1" type:"string"`

	// The distance unit of a room profile.
	DistanceUnit DistanceUnit `type:"string" enum:"true"`

	// The max volume limit of a room profile.
	MaxVolumeLimit *int64 `type:"integer"`

	// The PSTN setting of a room profile.
	PSTNEnabled *bool `type:"boolean"`

	// The ARN of a room profile.
	ProfileArn *string `type:"string"`

	// The name of a room profile.
	ProfileName *string `min:"1" type:"string"`

	// The setup mode of a room profile.
	SetupModeDisabled *bool `type:"boolean"`

	// The temperature unit of a room profile.
	TemperatureUnit TemperatureUnit `type:"string" enum:"true"`

	// The time zone of a room profile.
	Timezone *string `min:"1" type:"string"`

	// The wake word of a room profile.
	WakeWord WakeWord `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A room profile with attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Profile

func (Profile) GoString

func (s Profile) GoString() string

GoString returns the string representation

func (Profile) String

func (s Profile) String() string

String returns the string representation

type ProfileData

type ProfileData struct {

	// The address of a room profile.
	Address *string `min:"1" type:"string"`

	// The distance unit of a room profile.
	DistanceUnit DistanceUnit `type:"string" enum:"true"`

	// The ARN of a room profile.
	ProfileArn *string `type:"string"`

	// The name of a room profile.
	ProfileName *string `min:"1" type:"string"`

	// The temperature unit of a room profile.
	TemperatureUnit TemperatureUnit `type:"string" enum:"true"`

	// The timezone of a room profile.
	Timezone *string `min:"1" type:"string"`

	// The wake word of a room profile.
	WakeWord WakeWord `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The data of a room profile. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ProfileData

func (ProfileData) GoString

func (s ProfileData) GoString() string

GoString returns the string representation

func (ProfileData) String

func (s ProfileData) String() string

String returns the string representation

type PutRoomSkillParameterInput

type PutRoomSkillParameterInput struct {

	// The ARN of the room associated with the room skill parameter. Required.
	RoomArn *string `type:"string"`

	// The updated room skill parameter. Required.
	//
	// RoomSkillParameter is a required field
	RoomSkillParameter *RoomSkillParameter `type:"structure" required:"true"`

	// The ARN of the skill associated with the room skill parameter. Required.
	//
	// SkillId is a required field
	SkillId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutRoomSkillParameterRequest

func (PutRoomSkillParameterInput) GoString

func (s PutRoomSkillParameterInput) GoString() string

GoString returns the string representation

func (PutRoomSkillParameterInput) String

String returns the string representation

func (*PutRoomSkillParameterInput) Validate

func (s *PutRoomSkillParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRoomSkillParameterOutput

type PutRoomSkillParameterOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutRoomSkillParameterResponse

func (PutRoomSkillParameterOutput) GoString

func (s PutRoomSkillParameterOutput) GoString() string

GoString returns the string representation

func (PutRoomSkillParameterOutput) SDKResponseMetadata

func (s PutRoomSkillParameterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutRoomSkillParameterOutput) String

String returns the string representation

type PutRoomSkillParameterRequest

type PutRoomSkillParameterRequest struct {
	*aws.Request
	Input *PutRoomSkillParameterInput
	Copy  func(*PutRoomSkillParameterInput) PutRoomSkillParameterRequest
}

PutRoomSkillParameterRequest is a API request type for the PutRoomSkillParameter API operation.

func (PutRoomSkillParameterRequest) Send

Send marshals and sends the PutRoomSkillParameter API request.

type ResolveRoomInput

type ResolveRoomInput struct {

	// The ARN of the skill that was requested. Required.
	//
	// SkillId is a required field
	SkillId *string `type:"string" required:"true"`

	// The ARN of the user. Required.
	//
	// UserId is a required field
	UserId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ResolveRoomRequest

func (ResolveRoomInput) GoString

func (s ResolveRoomInput) GoString() string

GoString returns the string representation

func (ResolveRoomInput) String

func (s ResolveRoomInput) String() string

String returns the string representation

func (*ResolveRoomInput) Validate

func (s *ResolveRoomInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResolveRoomOutput

type ResolveRoomOutput struct {

	// The ARN of the room from which the skill request was invoked.
	RoomArn *string `type:"string"`

	// The name of the room from which the skill request was invoked.
	RoomName *string `min:"1" type:"string"`

	// Response to get the room profile request. Required.
	RoomSkillParameters []RoomSkillParameter `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ResolveRoomResponse

func (ResolveRoomOutput) GoString

func (s ResolveRoomOutput) GoString() string

GoString returns the string representation

func (ResolveRoomOutput) SDKResponseMetadata

func (s ResolveRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ResolveRoomOutput) String

func (s ResolveRoomOutput) String() string

String returns the string representation

type ResolveRoomRequest

type ResolveRoomRequest struct {
	*aws.Request
	Input *ResolveRoomInput
	Copy  func(*ResolveRoomInput) ResolveRoomRequest
}

ResolveRoomRequest is a API request type for the ResolveRoom API operation.

func (ResolveRoomRequest) Send

Send marshals and sends the ResolveRoom API request.

type RevokeInvitationInput

type RevokeInvitationInput struct {

	// The ARN of the enrollment invitation to revoke. Required.
	EnrollmentId *string `type:"string"`

	// The ARN of the user for whom to revoke an enrollment invitation. Required.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RevokeInvitationRequest

func (RevokeInvitationInput) GoString

func (s RevokeInvitationInput) GoString() string

GoString returns the string representation

func (RevokeInvitationInput) String

func (s RevokeInvitationInput) String() string

String returns the string representation

type RevokeInvitationOutput

type RevokeInvitationOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RevokeInvitationResponse

func (RevokeInvitationOutput) GoString

func (s RevokeInvitationOutput) GoString() string

GoString returns the string representation

func (RevokeInvitationOutput) SDKResponseMetadata

func (s RevokeInvitationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (RevokeInvitationOutput) String

func (s RevokeInvitationOutput) String() string

String returns the string representation

type RevokeInvitationRequest

type RevokeInvitationRequest struct {
	*aws.Request
	Input *RevokeInvitationInput
	Copy  func(*RevokeInvitationInput) RevokeInvitationRequest
}

RevokeInvitationRequest is a API request type for the RevokeInvitation API operation.

func (RevokeInvitationRequest) Send

Send marshals and sends the RevokeInvitation API request.

type Room

type Room struct {

	// The description of a room.
	Description *string `min:"1" type:"string"`

	// The profile ARN of a room.
	ProfileArn *string `type:"string"`

	// The provider calendar ARN of a room.
	ProviderCalendarId *string `type:"string"`

	// The ARN of a room.
	RoomArn *string `type:"string"`

	// The name of a room.
	RoomName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A room with attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Room

func (Room) GoString

func (s Room) GoString() string

GoString returns the string representation

func (Room) String

func (s Room) String() string

String returns the string representation

type RoomData

type RoomData struct {

	// The description of a room.
	Description *string `min:"1" type:"string"`

	// The profile ARN of a room.
	ProfileArn *string `type:"string"`

	// The profile name of a room.
	ProfileName *string `min:"1" type:"string"`

	// The provider calendar ARN of a room.
	ProviderCalendarId *string `type:"string"`

	// The ARN of a room.
	RoomArn *string `type:"string"`

	// The name of a room.
	RoomName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The data of a room. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RoomData

func (RoomData) GoString

func (s RoomData) GoString() string

GoString returns the string representation

func (RoomData) String

func (s RoomData) String() string

String returns the string representation

type RoomSkillParameter

type RoomSkillParameter struct {

	// The parameter key of a room skill parameter. ParameterKey is an enumerated
	// type that only takes “DEFAULT” or “SCOPE” as valid values.
	//
	// ParameterKey is a required field
	ParameterKey *string `min:"1" type:"string" required:"true"`

	// The parameter value of a room skill parameter.
	//
	// ParameterValue is a required field
	ParameterValue *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A skill parameter associated with a room. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RoomSkillParameter

func (RoomSkillParameter) GoString

func (s RoomSkillParameter) GoString() string

GoString returns the string representation

func (RoomSkillParameter) String

func (s RoomSkillParameter) String() string

String returns the string representation

func (*RoomSkillParameter) Validate

func (s *RoomSkillParameter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchDevicesInput

type SearchDevicesInput struct {

	// The filters to use to list a specified set of devices. Supported filter keys
	// are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType,
	// DeviceSerialNumber, and UnassociatedOnly.
	Filters []Filter `type:"list"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The sort order to use in listing the specified set of devices. Supported
	// sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, and DeviceSerialNumber.
	SortCriteria []Sort `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchDevicesRequest

func (SearchDevicesInput) GoString

func (s SearchDevicesInput) GoString() string

GoString returns the string representation

func (SearchDevicesInput) String

func (s SearchDevicesInput) String() string

String returns the string representation

func (*SearchDevicesInput) Validate

func (s *SearchDevicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchDevicesOutput

type SearchDevicesOutput struct {

	// The devices that meet the specified set of filter criteria, in sort order.
	Devices []DeviceData `type:"list"`

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The total number of devices returned.
	TotalCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchDevicesResponse

func (SearchDevicesOutput) GoString

func (s SearchDevicesOutput) GoString() string

GoString returns the string representation

func (SearchDevicesOutput) SDKResponseMetadata

func (s SearchDevicesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchDevicesOutput) String

func (s SearchDevicesOutput) String() string

String returns the string representation

type SearchDevicesPager added in v0.3.0

type SearchDevicesPager struct {
	aws.Pager
}

SearchDevicesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SearchDevicesPager) CurrentPage added in v0.3.0

func (p *SearchDevicesPager) CurrentPage() *SearchDevicesOutput

type SearchDevicesRequest

type SearchDevicesRequest struct {
	*aws.Request
	Input *SearchDevicesInput
	Copy  func(*SearchDevicesInput) SearchDevicesRequest
}

SearchDevicesRequest is a API request type for the SearchDevices API operation.

func (*SearchDevicesRequest) Paginate added in v0.3.0

func (p *SearchDevicesRequest) Paginate(opts ...aws.Option) SearchDevicesPager

Paginate pages iterates over the pages of a SearchDevicesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a SearchDevices operation.
		req := client.SearchDevicesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SearchDevicesRequest) Send

Send marshals and sends the SearchDevices API request.

type SearchProfilesInput

type SearchProfilesInput struct {

	// The filters to use to list a specified set of room profiles. Supported filter
	// keys are ProfileName and Address. Required.
	Filters []Filter `type:"list"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The sort order to use in listing the specified set of room profiles. Supported
	// sort keys are ProfileName and Address.
	SortCriteria []Sort `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchProfilesRequest

func (SearchProfilesInput) GoString

func (s SearchProfilesInput) GoString() string

GoString returns the string representation

func (SearchProfilesInput) String

func (s SearchProfilesInput) String() string

String returns the string representation

func (*SearchProfilesInput) Validate

func (s *SearchProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchProfilesOutput

type SearchProfilesOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The profiles that meet the specified set of filter criteria, in sort order.
	Profiles []ProfileData `type:"list"`

	// The total number of room profiles returned.
	TotalCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchProfilesResponse

func (SearchProfilesOutput) GoString

func (s SearchProfilesOutput) GoString() string

GoString returns the string representation

func (SearchProfilesOutput) SDKResponseMetadata

func (s SearchProfilesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchProfilesOutput) String

func (s SearchProfilesOutput) String() string

String returns the string representation

type SearchProfilesPager added in v0.3.0

type SearchProfilesPager struct {
	aws.Pager
}

SearchProfilesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SearchProfilesPager) CurrentPage added in v0.3.0

func (p *SearchProfilesPager) CurrentPage() *SearchProfilesOutput

type SearchProfilesRequest

type SearchProfilesRequest struct {
	*aws.Request
	Input *SearchProfilesInput
	Copy  func(*SearchProfilesInput) SearchProfilesRequest
}

SearchProfilesRequest is a API request type for the SearchProfiles API operation.

func (*SearchProfilesRequest) Paginate added in v0.3.0

func (p *SearchProfilesRequest) Paginate(opts ...aws.Option) SearchProfilesPager

Paginate pages iterates over the pages of a SearchProfilesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a SearchProfiles operation.
		req := client.SearchProfilesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SearchProfilesRequest) Send

Send marshals and sends the SearchProfiles API request.

type SearchRoomsInput

type SearchRoomsInput struct {

	// The filters to use to list a specified set of rooms. The supported filter
	// keys are RoomName and ProfileName.
	Filters []Filter `type:"list"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The sort order to use in listing the specified set of rooms. The supported
	// sort keys are RoomName and ProfileName.
	SortCriteria []Sort `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchRoomsRequest

func (SearchRoomsInput) GoString

func (s SearchRoomsInput) GoString() string

GoString returns the string representation

func (SearchRoomsInput) String

func (s SearchRoomsInput) String() string

String returns the string representation

func (*SearchRoomsInput) Validate

func (s *SearchRoomsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchRoomsOutput

type SearchRoomsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The rooms that meet the specified set of filter criteria, in sort order.
	Rooms []RoomData `type:"list"`

	// The total number of rooms returned.
	TotalCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchRoomsResponse

func (SearchRoomsOutput) GoString

func (s SearchRoomsOutput) GoString() string

GoString returns the string representation

func (SearchRoomsOutput) SDKResponseMetadata

func (s SearchRoomsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchRoomsOutput) String

func (s SearchRoomsOutput) String() string

String returns the string representation

type SearchRoomsPager added in v0.3.0

type SearchRoomsPager struct {
	aws.Pager
}

SearchRoomsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SearchRoomsPager) CurrentPage added in v0.3.0

func (p *SearchRoomsPager) CurrentPage() *SearchRoomsOutput

type SearchRoomsRequest

type SearchRoomsRequest struct {
	*aws.Request
	Input *SearchRoomsInput
	Copy  func(*SearchRoomsInput) SearchRoomsRequest
}

SearchRoomsRequest is a API request type for the SearchRooms API operation.

func (*SearchRoomsRequest) Paginate added in v0.3.0

func (p *SearchRoomsRequest) Paginate(opts ...aws.Option) SearchRoomsPager

Paginate pages iterates over the pages of a SearchRoomsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a SearchRooms operation.
		req := client.SearchRoomsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SearchRoomsRequest) Send

Send marshals and sends the SearchRooms API request.

type SearchSkillGroupsInput

type SearchSkillGroupsInput struct {

	// The filters to use to list a specified set of skill groups. The supported
	// filter key is SkillGroupName.
	Filters []Filter `type:"list"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The sort order to use in listing the specified set of skill groups. The supported
	// sort key is SkillGroupName.
	SortCriteria []Sort `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchSkillGroupsRequest

func (SearchSkillGroupsInput) GoString

func (s SearchSkillGroupsInput) GoString() string

GoString returns the string representation

func (SearchSkillGroupsInput) String

func (s SearchSkillGroupsInput) String() string

String returns the string representation

func (*SearchSkillGroupsInput) Validate

func (s *SearchSkillGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchSkillGroupsOutput

type SearchSkillGroupsOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The skill groups that meet the filter criteria, in sort order.
	SkillGroups []SkillGroupData `type:"list"`

	// The total number of skill groups returned.
	TotalCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchSkillGroupsResponse

func (SearchSkillGroupsOutput) GoString

func (s SearchSkillGroupsOutput) GoString() string

GoString returns the string representation

func (SearchSkillGroupsOutput) SDKResponseMetadata

func (s SearchSkillGroupsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchSkillGroupsOutput) String

func (s SearchSkillGroupsOutput) String() string

String returns the string representation

type SearchSkillGroupsPager added in v0.3.0

type SearchSkillGroupsPager struct {
	aws.Pager
}

SearchSkillGroupsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SearchSkillGroupsPager) CurrentPage added in v0.3.0

type SearchSkillGroupsRequest

type SearchSkillGroupsRequest struct {
	*aws.Request
	Input *SearchSkillGroupsInput
	Copy  func(*SearchSkillGroupsInput) SearchSkillGroupsRequest
}

SearchSkillGroupsRequest is a API request type for the SearchSkillGroups API operation.

func (*SearchSkillGroupsRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a SearchSkillGroupsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a SearchSkillGroups operation.
		req := client.SearchSkillGroupsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SearchSkillGroupsRequest) Send

Send marshals and sends the SearchSkillGroups API request.

type SearchUsersInput

type SearchUsersInput struct {

	// The filters to use for listing a specific set of users. Required. Supported
	// filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
	Filters []Filter `type:"list"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The sort order to use in listing the filtered set of users. Required. Supported
	// sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
	SortCriteria []Sort `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchUsersRequest

func (SearchUsersInput) GoString

func (s SearchUsersInput) GoString() string

GoString returns the string representation

func (SearchUsersInput) String

func (s SearchUsersInput) String() string

String returns the string representation

func (*SearchUsersInput) Validate

func (s *SearchUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchUsersOutput

type SearchUsersOutput struct {

	// The token returned to indicate that there is more data available.
	NextToken *string `min:"1" type:"string"`

	// The total number of users returned.
	TotalCount *int64 `type:"integer"`

	// The users that meet the specified set of filter criteria, in sort order.
	Users []UserData `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchUsersResponse

func (SearchUsersOutput) GoString

func (s SearchUsersOutput) GoString() string

GoString returns the string representation

func (SearchUsersOutput) SDKResponseMetadata

func (s SearchUsersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchUsersOutput) String

func (s SearchUsersOutput) String() string

String returns the string representation

type SearchUsersPager added in v0.3.0

type SearchUsersPager struct {
	aws.Pager
}

SearchUsersPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*SearchUsersPager) CurrentPage added in v0.3.0

func (p *SearchUsersPager) CurrentPage() *SearchUsersOutput

type SearchUsersRequest

type SearchUsersRequest struct {
	*aws.Request
	Input *SearchUsersInput
	Copy  func(*SearchUsersInput) SearchUsersRequest
}

SearchUsersRequest is a API request type for the SearchUsers API operation.

func (*SearchUsersRequest) Paginate added in v0.3.0

func (p *SearchUsersRequest) Paginate(opts ...aws.Option) SearchUsersPager

Paginate pages iterates over the pages of a SearchUsersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service.

   // Example iterating over at most 3 pages of a SearchUsers operation.
		req := client.SearchUsersRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (SearchUsersRequest) Send

Send marshals and sends the SearchUsers API request.

type SendInvitationInput

type SendInvitationInput struct {

	// The ARN of the user to whom to send an invitation. Required.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendInvitationRequest

func (SendInvitationInput) GoString

func (s SendInvitationInput) GoString() string

GoString returns the string representation

func (SendInvitationInput) String

func (s SendInvitationInput) String() string

String returns the string representation

type SendInvitationOutput

type SendInvitationOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendInvitationResponse

func (SendInvitationOutput) GoString

func (s SendInvitationOutput) GoString() string

GoString returns the string representation

func (SendInvitationOutput) SDKResponseMetadata

func (s SendInvitationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SendInvitationOutput) String

func (s SendInvitationOutput) String() string

String returns the string representation

type SendInvitationRequest

type SendInvitationRequest struct {
	*aws.Request
	Input *SendInvitationInput
	Copy  func(*SendInvitationInput) SendInvitationRequest
}

SendInvitationRequest is a API request type for the SendInvitation API operation.

func (SendInvitationRequest) Send

Send marshals and sends the SendInvitation API request.

type SkillGroup

type SkillGroup struct {

	// The description of a skill group.
	Description *string `min:"1" type:"string"`

	// The ARN of a skill group.
	SkillGroupArn *string `type:"string"`

	// The name of a skill group.
	SkillGroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A skill group with attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillGroup

func (SkillGroup) GoString

func (s SkillGroup) GoString() string

GoString returns the string representation

func (SkillGroup) String

func (s SkillGroup) String() string

String returns the string representation

type SkillGroupData

type SkillGroupData struct {

	// The description of a skill group.
	Description *string `min:"1" type:"string"`

	// The skill group ARN of a skill group.
	SkillGroupArn *string `type:"string"`

	// The skill group name of a skill group.
	SkillGroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The attributes of a skill group. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillGroupData

func (SkillGroupData) GoString

func (s SkillGroupData) GoString() string

GoString returns the string representation

func (SkillGroupData) String

func (s SkillGroupData) String() string

String returns the string representation

type SkillSummary

type SkillSummary struct {

	// The ARN of the skill summary.
	SkillId *string `type:"string"`

	// The name of the skill.
	SkillName *string `min:"1" type:"string"`

	// Linking support for a skill.
	SupportsLinking *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The summary of skills. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillSummary

func (SkillSummary) GoString

func (s SkillSummary) GoString() string

GoString returns the string representation

func (SkillSummary) String

func (s SkillSummary) String() string

String returns the string representation

type Sort

type Sort struct {

	// The sort key of a sort object.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The sort value of a sort object.
	//
	// Value is a required field
	Value SortValue `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

An object representing a sort criteria. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Sort

func (Sort) GoString

func (s Sort) GoString() string

GoString returns the string representation

func (Sort) String

func (s Sort) String() string

String returns the string representation

func (*Sort) Validate

func (s *Sort) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SortValue

type SortValue string
const (
	SortValueAsc  SortValue = "ASC"
	SortValueDesc SortValue = "DESC"
)

Enum values for SortValue

func (SortValue) MarshalValue added in v0.3.0

func (enum SortValue) MarshalValue() (string, error)

func (SortValue) MarshalValueBuf added in v0.3.0

func (enum SortValue) MarshalValueBuf(b []byte) ([]byte, error)

type StartDeviceSyncInput

type StartDeviceSyncInput struct {

	// The ARN of the device to sync. Required.
	DeviceArn *string `type:"string"`

	// Request structure to start the device sync. Required.
	//
	// Features is a required field
	Features []Feature `type:"list" required:"true"`

	// The ARN of the room with which the device to sync is associated. Required.
	RoomArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartDeviceSyncRequest

func (StartDeviceSyncInput) GoString

func (s StartDeviceSyncInput) GoString() string

GoString returns the string representation

func (StartDeviceSyncInput) String

func (s StartDeviceSyncInput) String() string

String returns the string representation

func (*StartDeviceSyncInput) Validate

func (s *StartDeviceSyncInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDeviceSyncOutput

type StartDeviceSyncOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartDeviceSyncResponse

func (StartDeviceSyncOutput) GoString

func (s StartDeviceSyncOutput) GoString() string

GoString returns the string representation

func (StartDeviceSyncOutput) SDKResponseMetadata

func (s StartDeviceSyncOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StartDeviceSyncOutput) String

func (s StartDeviceSyncOutput) String() string

String returns the string representation

type StartDeviceSyncRequest

type StartDeviceSyncRequest struct {
	*aws.Request
	Input *StartDeviceSyncInput
	Copy  func(*StartDeviceSyncInput) StartDeviceSyncRequest
}

StartDeviceSyncRequest is a API request type for the StartDeviceSync API operation.

func (StartDeviceSyncRequest) Send

Send marshals and sends the StartDeviceSync API request.

type Tag

type Tag struct {

	// The key of a tag. Tag keys are case-sensitive.
	Key *string `min:"1" type:"string"`

	// The value of a tag. Tag values are case-sensitive and can be null.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A key-value pair that can be associated with a resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Tag

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the resource to which to add metadata tags. Required.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The tags to be added to the specified resource. Do not provide system tags.
	// Required.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/TagResourceRequest

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/TagResourceResponse

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) SDKResponseMetadata

func (s TagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is a API request type for the TagResource API operation.

func (TagResourceRequest) Send

Send marshals and sends the TagResource API request.

type TemperatureUnit

type TemperatureUnit string
const (
	TemperatureUnitFahrenheit TemperatureUnit = "FAHRENHEIT"
	TemperatureUnitCelsius    TemperatureUnit = "CELSIUS"
)

Enum values for TemperatureUnit

func (TemperatureUnit) MarshalValue added in v0.3.0

func (enum TemperatureUnit) MarshalValue() (string, error)

func (TemperatureUnit) MarshalValueBuf added in v0.3.0

func (enum TemperatureUnit) MarshalValueBuf(b []byte) ([]byte, error)

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the resource from which to remove metadata tags. Required.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The tags to be removed from the specified resource. Do not provide system
	// tags. Required.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UntagResourceRequest

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UntagResourceResponse

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) SDKResponseMetadata

func (s UntagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is a API request type for the UntagResource API operation.

func (UntagResourceRequest) Send

Send marshals and sends the UntagResource API request.

type UpdateDeviceInput

type UpdateDeviceInput struct {

	// The ARN of the device to update. Required.
	DeviceArn *string `type:"string"`

	// The updated device name. Required.
	DeviceName *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateDeviceRequest

func (UpdateDeviceInput) GoString

func (s UpdateDeviceInput) GoString() string

GoString returns the string representation

func (UpdateDeviceInput) String

func (s UpdateDeviceInput) String() string

String returns the string representation

func (*UpdateDeviceInput) Validate

func (s *UpdateDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDeviceOutput

type UpdateDeviceOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateDeviceResponse

func (UpdateDeviceOutput) GoString

func (s UpdateDeviceOutput) GoString() string

GoString returns the string representation

func (UpdateDeviceOutput) SDKResponseMetadata

func (s UpdateDeviceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateDeviceOutput) String

func (s UpdateDeviceOutput) String() string

String returns the string representation

type UpdateDeviceRequest

type UpdateDeviceRequest struct {
	*aws.Request
	Input *UpdateDeviceInput
	Copy  func(*UpdateDeviceInput) UpdateDeviceRequest
}

UpdateDeviceRequest is a API request type for the UpdateDevice API operation.

func (UpdateDeviceRequest) Send

Send marshals and sends the UpdateDevice API request.

type UpdateProfileInput

type UpdateProfileInput struct {

	// The updated address for the room profile.
	Address *string `min:"1" type:"string"`

	// The updated distance unit for the room profile.
	DistanceUnit DistanceUnit `type:"string" enum:"true"`

	// The updated maximum volume limit for the room profile.
	MaxVolumeLimit *int64 `type:"integer"`

	// Whether the PSTN setting of the room profile is enabled.
	PSTNEnabled *bool `type:"boolean"`

	// The ARN of the room profile to update. Required.
	ProfileArn *string `type:"string"`

	// The updated name for the room profile.
	ProfileName *string `min:"1" type:"string"`

	// Whether the setup mode of the profile is enabled.
	SetupModeDisabled *bool `type:"boolean"`

	// The updated temperature unit for the room profile.
	TemperatureUnit TemperatureUnit `type:"string" enum:"true"`

	// The updated timezone for the room profile.
	Timezone *string `min:"1" type:"string"`

	// The updated wake word for the room profile.
	WakeWord WakeWord `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateProfileRequest

func (UpdateProfileInput) GoString

func (s UpdateProfileInput) GoString() string

GoString returns the string representation

func (UpdateProfileInput) String

func (s UpdateProfileInput) String() string

String returns the string representation

func (*UpdateProfileInput) Validate

func (s *UpdateProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProfileOutput

type UpdateProfileOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateProfileResponse

func (UpdateProfileOutput) GoString

func (s UpdateProfileOutput) GoString() string

GoString returns the string representation

func (UpdateProfileOutput) SDKResponseMetadata

func (s UpdateProfileOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateProfileOutput) String

func (s UpdateProfileOutput) String() string

String returns the string representation

type UpdateProfileRequest

type UpdateProfileRequest struct {
	*aws.Request
	Input *UpdateProfileInput
	Copy  func(*UpdateProfileInput) UpdateProfileRequest
}

UpdateProfileRequest is a API request type for the UpdateProfile API operation.

func (UpdateProfileRequest) Send

Send marshals and sends the UpdateProfile API request.

type UpdateRoomInput

type UpdateRoomInput struct {

	// The updated description for the room.
	Description *string `min:"1" type:"string"`

	// The updated profile ARN for the room.
	ProfileArn *string `type:"string"`

	// The updated provider calendar ARN for the room.
	ProviderCalendarId *string `type:"string"`

	// The ARN of the room to update.
	RoomArn *string `type:"string"`

	// The updated name for the room.
	RoomName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateRoomRequest

func (UpdateRoomInput) GoString

func (s UpdateRoomInput) GoString() string

GoString returns the string representation

func (UpdateRoomInput) String

func (s UpdateRoomInput) String() string

String returns the string representation

func (*UpdateRoomInput) Validate

func (s *UpdateRoomInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRoomOutput

type UpdateRoomOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateRoomResponse

func (UpdateRoomOutput) GoString

func (s UpdateRoomOutput) GoString() string

GoString returns the string representation

func (UpdateRoomOutput) SDKResponseMetadata

func (s UpdateRoomOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateRoomOutput) String

func (s UpdateRoomOutput) String() string

String returns the string representation

type UpdateRoomRequest

type UpdateRoomRequest struct {
	*aws.Request
	Input *UpdateRoomInput
	Copy  func(*UpdateRoomInput) UpdateRoomRequest
}

UpdateRoomRequest is a API request type for the UpdateRoom API operation.

func (UpdateRoomRequest) Send

Send marshals and sends the UpdateRoom API request.

type UpdateSkillGroupInput

type UpdateSkillGroupInput struct {

	// The updated description for the skill group.
	Description *string `min:"1" type:"string"`

	// The ARN of the skill group to update.
	SkillGroupArn *string `type:"string"`

	// The updated name for the skill group.
	SkillGroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateSkillGroupRequest

func (UpdateSkillGroupInput) GoString

func (s UpdateSkillGroupInput) GoString() string

GoString returns the string representation

func (UpdateSkillGroupInput) String

func (s UpdateSkillGroupInput) String() string

String returns the string representation

func (*UpdateSkillGroupInput) Validate

func (s *UpdateSkillGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSkillGroupOutput

type UpdateSkillGroupOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateSkillGroupResponse

func (UpdateSkillGroupOutput) GoString

func (s UpdateSkillGroupOutput) GoString() string

GoString returns the string representation

func (UpdateSkillGroupOutput) SDKResponseMetadata

func (s UpdateSkillGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateSkillGroupOutput) String

func (s UpdateSkillGroupOutput) String() string

String returns the string representation

type UpdateSkillGroupRequest

type UpdateSkillGroupRequest struct {
	*aws.Request
	Input *UpdateSkillGroupInput
	Copy  func(*UpdateSkillGroupInput) UpdateSkillGroupRequest
}

UpdateSkillGroupRequest is a API request type for the UpdateSkillGroup API operation.

func (UpdateSkillGroupRequest) Send

Send marshals and sends the UpdateSkillGroup API request.

type UserData

type UserData struct {

	// The email of a user.
	Email *string `min:"1" type:"string"`

	// The enrollment ARN of a user.
	EnrollmentId *string `type:"string"`

	// The enrollment status of a user.
	EnrollmentStatus EnrollmentStatus `type:"string" enum:"true"`

	// The first name of a user.
	FirstName *string `type:"string"`

	// The last name of a user.
	LastName *string `type:"string"`

	// The ARN of a user.
	UserArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information related to a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UserData

func (UserData) GoString

func (s UserData) GoString() string

GoString returns the string representation

func (UserData) String

func (s UserData) String() string

String returns the string representation

type WakeWord

type WakeWord string
const (
	WakeWordAlexa    WakeWord = "ALEXA"
	WakeWordAmazon   WakeWord = "AMAZON"
	WakeWordEcho     WakeWord = "ECHO"
	WakeWordComputer WakeWord = "COMPUTER"
)

Enum values for WakeWord

func (WakeWord) MarshalValue added in v0.3.0

func (enum WakeWord) MarshalValue() (string, error)

func (WakeWord) MarshalValueBuf added in v0.3.0

func (enum WakeWord) MarshalValueBuf(b []byte) ([]byte, error)

Directories

Path Synopsis
Package alexaforbusinessiface provides an interface to enable mocking the Alexa For Business service client for testing your code.
Package alexaforbusinessiface provides an interface to enable mocking the Alexa For Business service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL