Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The ARN of the app block.

[required] The name of the app block builder.

[required] The name of the fleet.

[required] The ARN of the application.

[required] The name of the stack.

[required] The name of the entitlement.

[required] The identifier of the application.

[required] The name of the fleet.

[required] The name of the stack.

[required] The list of UserStackAssociation objects.

[required] The list of UserStackAssociation objects.

[required] The name of the image to copy.

[required] The name that the image will have when it is copied to the destination.

[required] The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

The description that the image will have when it is copied to the destination.

[required] The name of the app block.

The description of the app block.

The display name of the app block. This is not displayed to the user.

[required] The source S3 location of the app block.

The setup script details of the app block. This must be provided for the CUSTOM PackagingType.

The tags assigned to the app block.

The post setup script details of the app block. This can only be provided for the APPSTREAM2 PackagingType.

The packaging type of the app block.

[required] The unique name for the app block builder.

The description of the app block builder.

The display name of the app block builder.

The tags to associate with the app block builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

[required] The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

[required] The instance type to use when launching the app block builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

[required] The VPC configuration for the app block builder.

App block builders require that you specify at least two subnets in different availability zones.

Enables or disables default internet access for the app block builder.

The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.

[required] The name of the app block builder.

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

[required] The name of the application. This name is visible to users when display name is not specified.

The display name of the application. This name is visible to users in the application catalog.

The description of the application.

[required] The location in S3 of the application icon.

[required] The launch path of the application.

The working directory of the application.

The launch parameters of the application.

[required] The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

[required] The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.

[required] The app block ARN to which the application should be associated

The tags assigned to the application.

[required] The fully qualified name of the directory (for example, corp.example.com).

[required] The distinguished names of the organizational units for computer accounts.

The credentials for the service account used by the fleet or image builder to connect to the directory.

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

[required] The name of the entitlement.

[required] The name of the stack with which the entitlement is associated.

The description of the entitlement.

[required] Specifies whether all or selected apps are entitled.

[required] The attributes of the entitlement.

[required] A unique name for the fleet.

The name of the image used to create the fleet.

The ARN of the public, private, or shared image to use.

[required] The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics.g5.xlarge

• stream.graphics.g5.2xlarge

• stream.graphics.g5.4xlarge

• stream.graphics.g5.8xlarge

• stream.graphics.g5.12xlarge

• stream.graphics.g5.16xlarge

• stream.graphics.g5.24xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

The description to display.

The fleet name to display.

Enables or disables default internet access for the fleet.

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

[required] A unique name for the image builder.

The name of the image used to create the image builder.

The ARN of the public, private, or shared image to use.

[required] The instance type to use when launching the image builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The description to display.

The image builder name to display.

The VPC configuration for the image builder. You can specify only one subnet.

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

Enables or disables default internet access for the image builder.

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

[required] The name of the image builder.

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

[required] The name of the stack.

The description to display.

The stack name to display.

The storage connectors to enable.

The URL that users are redirected to after their streaming session ends.

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

[required] The name of the stack.

[required] The name of the fleet.

[required] The identifier of the user.

The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

[required] The name of the stack for the theme.

The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.

[required] The title that is displayed at the top of the browser tab during users' application streaming sessions.

[required] The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.

[required] The organization logo that appears on the streaming application catalog page.

[required] The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.

[required] The name of the image to update.

[required] The name of the new image. The name must be unique within the AWS account and Region.

The description to display for the new image.

The name to display for the new image.

The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

[required] The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

The first name, or given name, of the user.

The last name, or surname, of the user.

[required] The authentication type for the user. You must specify USERPOOL.

[required] The name of the app block.

[required] The name of the app block builder.

[required] The name of the application.

[required] The name of the directory configuration.

[required] The name of the entitlement.

[required] The name of the stack with which the entitlement is associated.

[required] The name of the fleet.

[required] The name of the image.

[required] The name of the image builder.

[required] The name of the private image.

[required] The 12-digit identifier of the AWS account for which to delete image permissions.

[required] The name of the stack.

[required] The name of the stack for the theme.

[required] The email address of the user.

Users' email addresses are case-sensitive.

[required] The authentication type for the user. You must specify USERPOOL.

The ARN of the app block.

The name of the app block builder.

The maximum size of each page of results.

The pagination token used to retrieve the next page of results for this operation.

The names of the app block builders.

The pagination token used to retrieve the next page of results for this operation.

The maximum size of each page of results. The maximum value is 25.

The ARNs of the app blocks.

The pagination token used to retrieve the next page of results for this operation.

The maximum size of each page of results.

The name of the fleet.

The ARN of the application.

The maximum size of each page of results.

The pagination token used to retrieve the next page of results for this operation.

The ARNs for the applications.

The pagination token used to retrieve the next page of results for this operation.

The maximum size of each page of results.

The directory names.

The maximum size of each page of results.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The name of the entitlement.

[required] The name of the stack with which the entitlement is associated.

The pagination token used to retrieve the next page of results for this operation.

The maximum size of each page of results.

The names of the fleets to describe.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The names of the image builders to describe.

The maximum size of each page of results.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The name of the private image for which to describe permissions. The image must be one that you own.

The maximum size of each page of results.

The 12-digit identifier of one or more AWS accounts with which the image is shared.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The names of the public or private images to describe.

The ARNs of the public, private, and shared images to describe.

The type of image (public, private, or shared) to describe.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The maximum size of each page of results.

[required] The name of the stack. This value is case-sensitive.

[required] The name of the fleet. This value is case-sensitive.

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The size of each page of results. The default value is 20 and the maximum value is 50.

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

The identifier for the instance hosting the session.

The names of the stacks to describe.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The name of the stack for the theme.

The maximum size of each page of results.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

The name of the stack that is associated with the user.

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

The maximum size of each page of results.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The authentication type for the users in the user pool to describe. You must specify USERPOOL.

The maximum size of each page of results.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The email address of the user.

Users' email addresses are case-sensitive.

[required] The authentication type for the user. You must specify USERPOOL.

[required] The ARN of the app block.

[required] The name of the app block builder.

[required] The name of the fleet.

[required] The ARN of the application.

[required] The name of the stack with which the entitlement is associated.

[required] The name of the entitlement.

[required] The identifier of the application to remove from the entitlement.

[required] The name of the fleet.

[required] The name of the stack.

[required] The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

[required] The authentication type for the user. You must specify USERPOOL.

[required] The identifier of the streaming session.

[required] The name of the stack.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The name of the fleet.

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

[required] The name of the stack with which the entitlement is associated.

[required] The name of the entitlement.

The pagination token used to retrieve the next page of results for this operation.

The maximum size of each page of results.

[required] The Amazon Resource Name (ARN) of the resource.

[required] The name of the app block builder.

[required] The name of the fleet.

[required] The name of the image builder.

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

[required] The name of the app block builder.

[required] The name of the fleet.

[required] The name of the image builder.

[required] The Amazon Resource Name (ARN) of the resource.

[required] The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

[required] The Amazon Resource Name (ARN) of the resource.

[required] The tag keys for the tags to disassociate.

[required] The unique name for the app block builder.

The description of the app block builder.

The display name of the app block builder.

The platform of the app block builder.

WINDOWS_SERVER_2019 is the only valid value.

The instance type to use when launching the app block builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

The VPC configuration for the app block builder.

App block builders require that you specify at least two subnets in different availability zones.

Enables or disables default internet access for the app block builder.

The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.

The attributes to delete from the app block builder.

[required] The name of the application. This name is visible to users when display name is not specified.

The display name of the application. This name is visible to users in the application catalog.

The description of the application.

The icon S3 location of the application.

The launch path of the application.

The working directory of the application.

The launch parameters of the application.

The ARN of the app block.

The attributes to delete for an application.

[required] The name of the Directory Config object.

The distinguished names of the organizational units for computer accounts.

The credentials for the service account used by the fleet or image builder to connect to the directory.

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

[required] The name of the entitlement.

[required] The name of the stack with which the entitlement is associated.

The description of the entitlement.

Specifies whether all or only selected apps are entitled.

The attributes of the entitlement.

The name of the image used to create the fleet.

The ARN of the public, private, or shared image to use.

A unique name for the fleet.

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

The desired capacity for the fleet. This is not allowed for Elastic fleets.

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

Deletes the VPC association for the specified fleet.

The description to display.

The fleet name to display.

Enables or disables default internet access for the fleet.

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

The fleet attributes to delete.

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

The maximum number of concurrent sessions for a fleet.

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

[required] The name of the private image.

[required] The 12-digit identifier of the AWS account for which you want add or update image permissions.

[required] The permissions for the image.

The stack name to display.

The description to display.

[required] The name of the stack.

The storage connectors to enable.

Deletes the storage connectors currently enabled for the stack.

The URL that users are redirected to after their streaming session ends.

The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

The stack attributes to delete.

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

[required] The name of the stack for the theme.

The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.

The title that is displayed at the top of the browser tab during users' application streaming sessions.

The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.

The organization logo that appears on the streaming application catalog page.

The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.

Specifies whether custom branding should be applied to catalog page or not.

The attributes to delete.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The resource Amazon Resource Name (ARN) to link.

[required] The channel configuration to associate with the resource.

[required] A description of the webhook. We recommend using the convention RoomName/WebhookName.

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

[required] The URL for the Amazon Chime webhook.

[required] The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

[required] A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

[required] The name of the configuration.

Logging levels include ERROR, INFO, or NONE.

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

[required] The definition of the command to run when invoked as an alias or as an action button.

The name used to invoke this action in a chat channel. For example, ⁠@aws run my-alias⁠.

Defines when this custom action button should be attached to a notification.

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

[required] The name of the custom action. This name is included in the Amazon Resource Name (ARN).

[required] The ID of the Microsoft Teams channel.

The name of the Microsoft Teams channel.

[required] The ID of the Microsoft Teams authorized with AWS Chatbot.

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

The name of the Microsoft Teams Team.

[required] The ID of the Microsoft Teams tenant.

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

[required] A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

[required] The name of the configuration.

Logging levels include ERROR, INFO, or NONE.

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.

Enables use of a user role requirement in your chat configuration.

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

[required] The ID of the Slack workspace authorized with AWS Chatbot.

[required] The ID of the Slack channel.

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

The name of the Slack channel.

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

[required] A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

[required] The name of the configuration.

Logging levels include ERROR, INFO, or NONE.

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.

Enables use of a user role requirement in your chat configuration.

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

[required] The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.

[required] The fully defined ARN of the custom action.

[required] The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

[required] The ID of the Microsoft Teams team authorized with AWS Chatbot.

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

[required] The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

[required] The Microsoft Teams user ID.

[required] The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete.

[required] The ARN of the SlackChannelConfiguration associated with the user identity to delete.

[required] The ID of the Slack workspace authorized with AWS Chatbot.

[required] The ID of the user in Slack

[required] The ID of the Slack workspace authorized with AWS Chatbot.

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.

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.

An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.

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.

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.

An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration to describe.

The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

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.

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.

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.

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] The resource (for example, a custom action) Amazon Resource Name (ARN) to unlink.

[required] The channel configuration the resource is being disassociated from.

[required] Returns the fully defined Amazon Resource Name (ARN) of the custom action.

[required] The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

[required] The channel configuration to list associations for.

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.

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.

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.

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.

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.

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.

The ID of the Microsoft Teams authorized with AWS Chatbot.

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

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.

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.

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

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.

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] The ARN of the resource to list tags for.

[required] The ARN of the configuration.

[required] A list of tags to apply to the configuration.

[required] The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

[required] TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

Enables use of a user role requirement in your chat configuration.

Turns on training data collection.

This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot.

[required] The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to update.

A description of the webhook. We recommend using the convention RoomName/WebhookName.

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

The URL for the Amazon Chime webhook.

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

Logging levels include ERROR, INFO, or NONE.

[required] The fully defined Amazon Resource Name (ARN) of the custom action.

[required] The definition of the command to run when invoked as an alias or as an action button.

The name used to invoke this action in the chat channel. For example, ⁠@aws run my-alias⁠.

Defines when this custom action button should be attached to a notification.

[required] The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to update.

[required] The ID of the Microsoft Teams channel.

The name of the Microsoft Teams channel.

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

Logging levels include ERROR, INFO, or NONE.

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.

Enables use of a user role requirement in your chat configuration.

[required] The Amazon Resource Name (ARN) of the SlackChannelConfiguration to update.

[required] The ID of the Slack channel.

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

The name of the Slack channel.

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

Logging levels include ERROR, INFO, or NONE.

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.

Enables use of a user role requirement in your chat configuration.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] Identifier of the room that the client is trying to access. Currently this must be an ARN.

[required] Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

Logging-configuration name. The value does not need to be unique.

[required] A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.

Room name. The value does not need to be unique.

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

Configuration information for optional review of messages.

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Array of logging-configuration identifiers attached to the room.

[required] Identifier of the logging configuration to be deleted.

[required] Identifier of the room where the message should be deleted. Currently this must be an ARN.

[required] ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

Reason for deleting the message.

[required] Identifier of the room to be deleted. Currently this must be an ARN.

[required] Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

[required] ID of the user (connection) to disconnect from the room.

Reason for disconnecting the user.

[required] Identifier of the logging configuration to be retrieved.

[required] Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.

Maximum number of logging configurations to return. Default: 50.

Filters the list to match the specified room name.

The first room to retrieve. This is used for pagination; see the nextToken response field.

Maximum number of rooms to return. Default: 50.

Filters the list to match the specified message review handler URI.

Logging-configuration identifier.

[required] The ARN of the resource to be retrieved. The ARN must be URL-encoded.

[required] Identifier of the room to which the event will be sent. Currently this must be an ARN.

[required] Application-defined name of the event to send to clients.

Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

[required] The ARN of the resource to be tagged. The ARN must be URL-encoded.

[required] Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

[required] The ARN of the resource to be untagged. The ARN must be URL-encoded.

[required] Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

[required] Identifier of the logging configuration to be updated.

Logging-configuration name. The value does not need to be unique.

A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

[required] Identifier of the room to be updated. Currently this must be an ARN.

Room name. The value does not need to be unique.

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

Array of logging-configuration identifiers attached to the room.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The ID of the version.

[required] The ID of the user.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource.

[required] The users, groups, or organization being granted permission.

The notification options.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The ID of the document version.

The ID of the parent comment.

The ID of the root comment in the thread.

[required] The text of the comment.

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource.

The ID of the version, if the custom metadata is being added to a document version.

[required] Custom metadata in the form of name-value pairs.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The name of the new folder.

[required] The ID of the parent folder.

[required] The ID of the resource.

[required] List of labels to add to the resource.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the organization.

[required] The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

[required] The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

[required] The notification type.

The ID of the organization.

[required] The login name of the user.

The email address of the user.

[required] The given name of the user.

[required] The surname of the user.

[required] The password of the user.

The time zone ID of the user.

The amount of storage for the user.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the user.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The ID of the document version.

[required] The ID of the comment.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource, either a document or folder.

The ID of the version, if the custom metadata is being deleted from a document version.

List of properties to remove.

Flag to indicate removal of all custom metadata properties from the specified resource.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document associated with the version being deleted.

[required] The ID of the version being deleted.

[required] Deletes all versions of a document prior to the current version.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

[required] The ID of the resource.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

List of labels to delete from the resource.

Flag to request removal of all labels from the specified resource.

[required] The ID of the subscription.

[required] The ID of the organization.

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.

[required] The ID of the user.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

The document or folder ID for which to describe activity types.

The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

The maximum number of items to return.

The marker for the next set of results.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The ID of the document version.

The maximum number of items to return.

The marker for the next set of results. This marker was received from a previous call.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

The marker for the next set of results. (You received this marker from a previous call.)

The maximum number of versions to return with this call.

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

Specify "SOURCE" to include initialized versions and a URL for the source document.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

The sorting criteria.

The order for the contents of the folder.

The maximum number of items to return with this call.

The marker for the next set of results. This marker was received from a previous call.

The type of items.

The contents to include. Specify "INITIALIZED" to include initialized documents.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] A query to describe groups by group name.

The ID of the organization.

The marker for the next set of results. (You received this marker from a previous call.)

The maximum number of items to return with this call.

[required] The ID of the organization.

The marker for the next set of results. (You received this marker from a previous call.)

The maximum number of items to return with this call.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource.

The ID of the principal to filter permissions by.

The maximum number of items to return with this call.

The marker for the next set of results. (You received this marker from a previous call)

[required] Amazon WorkDocs authentication token.

The maximum number of items to return.

The marker for the next set of results. (You received this marker from a previous call.)

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The ID of the organization.

The IDs of the users.

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a create_user API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on ⁠Ma J⁠ only returns Mateo Jackson.

The state of the users. Specify "ALL" to include inactive users.

The order for the results.

The sorting criteria.

The marker for the next set of results. (You received this marker from a previous call.)

The maximum number of items to return.

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

[required] Amazon WorkDocs authentication token.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

Set this to TRUE to include custom metadata in the response.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

The maximum number of levels in the hierarchy to return.

A comma-separated list of values. Specify NAME to include the names of the parent folders.

This value is not supported.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The version ID of the document.

A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

Set this to TRUE to include custom metadata in the response.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

Set to TRUE to include custom metadata in the response.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

The maximum number of levels in the hierarchy to return.

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

This value is not supported.

The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

The collection type.

The maximum number of resources to return.

The marker for the next set of results. This marker was received from a previous call.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The ID of the document.

The name of the document.

The timestamp when the content of the document was originally created.

The timestamp when the content of the document was modified.

The content type of the document.

The size of the document, in bytes.

The ID of the parent folder.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the resource.

[required] The principal ID of the resource.

The principal type of the resource.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

Filters results based on entity metadata.

Order by results in one or more categories.

Max results count per page.

The marker for the next set of results.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

The name of the document.

The ID of the parent folder.

The resource state of the document. Only ACTIVE and RECYCLED are supported.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the document.

[required] The version ID of the document.

The status of the version.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the folder.

The name of the folder.

The ID of the parent folder.

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

[required] The ID of the user.

The given name of the user.

The surname of the user.

The type of the user.

The amount of storage for the user.

The time zone ID of the user.

The locale of the user.

Boolean value to determine whether the user is granted Power user privileges.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The organization under which the resource exists.

[required] The resource for which members (users or groups) are associated.

The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

• Resource ID: r-0123456789a0123456789b0123456789

• Email address: resource@domain.tld

• Resource name: resource

[required] The member (user or group) to associate to the resource.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity: entity

[required] The organization under which the group exists.

[required] The group to which the member (user or group) is associated.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available: