Interface WickrClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Welcome to the Amazon Web Services Wickr API Reference.
The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr.
Using Amazon Web Services SDK
The SDK clients authenticate your requests by using access keys that you provide. For more information, see Authentication and access using Amazon Web Services SDKs and tools in the Amazon Web Services SDKs and Tools Reference Guide.
Using Amazon Web Services CLI
Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see Getting started with the Amazon Web Services CLI in the Amazon Web Services Command Line Interface User Guide for Version 2.
Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API requests in the Amazon Web Services Identity and Access Management User Guide.
Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy Amazon Web ServicesWickrFullAccess grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see Identity and access management for Amazon Web Services Wickr in the Amazon Web Services Wickr Administration Guide.
Types of Errors:
The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.
-
Client errors are indicated by HTTP Status Code class of 4xx
-
Service errors are indicated by HTTP Status Code class of 5xx
In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault BatchCreateUserResponsebatchCreateUser(Consumer<BatchCreateUserRequest.Builder> batchCreateUserRequest) Creates multiple users in a specified Wickr network.default BatchCreateUserResponsebatchCreateUser(BatchCreateUserRequest batchCreateUserRequest) Creates multiple users in a specified Wickr network.default BatchDeleteUserResponsebatchDeleteUser(Consumer<BatchDeleteUserRequest.Builder> batchDeleteUserRequest) Deletes multiple users from a specified Wickr network.default BatchDeleteUserResponsebatchDeleteUser(BatchDeleteUserRequest batchDeleteUserRequest) Deletes multiple users from a specified Wickr network.default BatchLookupUserUnameResponsebatchLookupUserUname(Consumer<BatchLookupUserUnameRequest.Builder> batchLookupUserUnameRequest) Looks up multiple user usernames from their unique username hashes (unames).default BatchLookupUserUnameResponsebatchLookupUserUname(BatchLookupUserUnameRequest batchLookupUserUnameRequest) Looks up multiple user usernames from their unique username hashes (unames).default BatchReinviteUserResponsebatchReinviteUser(Consumer<BatchReinviteUserRequest.Builder> batchReinviteUserRequest) Resends invitation codes to multiple users who have pending invitations in a Wickr network.default BatchReinviteUserResponsebatchReinviteUser(BatchReinviteUserRequest batchReinviteUserRequest) Resends invitation codes to multiple users who have pending invitations in a Wickr network.default BatchResetDevicesForUserResponsebatchResetDevicesForUser(Consumer<BatchResetDevicesForUserRequest.Builder> batchResetDevicesForUserRequest) Resets multiple devices for a specific user in a Wickr network.default BatchResetDevicesForUserResponsebatchResetDevicesForUser(BatchResetDevicesForUserRequest batchResetDevicesForUserRequest) Resets multiple devices for a specific user in a Wickr network.batchToggleUserSuspendStatus(Consumer<BatchToggleUserSuspendStatusRequest.Builder> batchToggleUserSuspendStatusRequest) Suspends or unsuspends multiple users in a Wickr network.batchToggleUserSuspendStatus(BatchToggleUserSuspendStatusRequest batchToggleUserSuspendStatusRequest) Suspends or unsuspends multiple users in a Wickr network.static WickrClientBuilderbuilder()Create a builder that can be used to configure and create aWickrClient.static WickrClientcreate()Create aWickrClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateBotResponsecreateBot(Consumer<CreateBotRequest.Builder> createBotRequest) Creates a new bot in a specified Wickr network.default CreateBotResponsecreateBot(CreateBotRequest createBotRequest) Creates a new bot in a specified Wickr network.default CreateDataRetentionBotResponsecreateDataRetentionBot(Consumer<CreateDataRetentionBotRequest.Builder> createDataRetentionBotRequest) Creates a data retention bot in a Wickr network.default CreateDataRetentionBotResponsecreateDataRetentionBot(CreateDataRetentionBotRequest createDataRetentionBotRequest) Creates a data retention bot in a Wickr network.createDataRetentionBotChallenge(Consumer<CreateDataRetentionBotChallengeRequest.Builder> createDataRetentionBotChallengeRequest) Creates a new challenge password for the data retention bot.createDataRetentionBotChallenge(CreateDataRetentionBotChallengeRequest createDataRetentionBotChallengeRequest) Creates a new challenge password for the data retention bot.default CreateNetworkResponsecreateNetwork(Consumer<CreateNetworkRequest.Builder> createNetworkRequest) Creates a new Wickr network with specified access level and configuration.default CreateNetworkResponsecreateNetwork(CreateNetworkRequest createNetworkRequest) Creates a new Wickr network with specified access level and configuration.default CreateSecurityGroupResponsecreateSecurityGroup(Consumer<CreateSecurityGroupRequest.Builder> createSecurityGroupRequest) Creates a new security group in a Wickr network.default CreateSecurityGroupResponsecreateSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) Creates a new security group in a Wickr network.default DeleteBotResponsedeleteBot(Consumer<DeleteBotRequest.Builder> deleteBotRequest) Deletes a bot from a specified Wickr network.default DeleteBotResponsedeleteBot(DeleteBotRequest deleteBotRequest) Deletes a bot from a specified Wickr network.default DeleteDataRetentionBotResponsedeleteDataRetentionBot(Consumer<DeleteDataRetentionBotRequest.Builder> deleteDataRetentionBotRequest) Deletes the data retention bot from a Wickr network.default DeleteDataRetentionBotResponsedeleteDataRetentionBot(DeleteDataRetentionBotRequest deleteDataRetentionBotRequest) Deletes the data retention bot from a Wickr network.default DeleteNetworkResponsedeleteNetwork(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest) Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings.default DeleteNetworkResponsedeleteNetwork(DeleteNetworkRequest deleteNetworkRequest) Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings.default DeleteSecurityGroupResponsedeleteSecurityGroup(Consumer<DeleteSecurityGroupRequest.Builder> deleteSecurityGroupRequest) Deletes a security group from a Wickr network.default DeleteSecurityGroupResponsedeleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) Deletes a security group from a Wickr network.default GetBotResponsegetBot(Consumer<GetBotRequest.Builder> getBotRequest) Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.default GetBotResponsegetBot(GetBotRequest getBotRequest) Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.default GetBotsCountResponsegetBotsCount(Consumer<GetBotsCountRequest.Builder> getBotsCountRequest) Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).default GetBotsCountResponsegetBotsCount(GetBotsCountRequest getBotsCountRequest) Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).default GetDataRetentionBotResponsegetDataRetentionBot(Consumer<GetDataRetentionBotRequest.Builder> getDataRetentionBotRequest) Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.default GetDataRetentionBotResponsegetDataRetentionBot(GetDataRetentionBotRequest getDataRetentionBotRequest) Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.default GetGuestUserHistoryCountResponsegetGuestUserHistoryCount(Consumer<GetGuestUserHistoryCountRequest.Builder> getGuestUserHistoryCountRequest) Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.default GetGuestUserHistoryCountResponsegetGuestUserHistoryCount(GetGuestUserHistoryCountRequest getGuestUserHistoryCountRequest) Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.default GetNetworkResponsegetNetwork(Consumer<GetNetworkRequest.Builder> getNetworkRequest) Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.default GetNetworkResponsegetNetwork(GetNetworkRequest getNetworkRequest) Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.default GetNetworkSettingsResponsegetNetworkSettings(Consumer<GetNetworkSettingsRequest.Builder> getNetworkSettingsRequest) Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.default GetNetworkSettingsResponsegetNetworkSettings(GetNetworkSettingsRequest getNetworkSettingsRequest) Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.default GetOidcInfoResponsegetOidcInfo(Consumer<GetOidcInfoRequest.Builder> getOidcInfoRequest) Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.default GetOidcInfoResponsegetOidcInfo(GetOidcInfoRequest getOidcInfoRequest) Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.default GetSecurityGroupResponsegetSecurityGroup(Consumer<GetSecurityGroupRequest.Builder> getSecurityGroupRequest) Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.default GetSecurityGroupResponsegetSecurityGroup(GetSecurityGroupRequest getSecurityGroupRequest) Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.default GetUserResponsegetUser(Consumer<GetUserRequest.Builder> getUserRequest) Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.default GetUserResponsegetUser(GetUserRequest getUserRequest) Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.default GetUsersCountResponsegetUsersCount(Consumer<GetUsersCountRequest.Builder> getUsersCountRequest) Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.default GetUsersCountResponsegetUsersCount(GetUsersCountRequest getUsersCountRequest) Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.default ListBlockedGuestUsersResponselistBlockedGuestUsers(Consumer<ListBlockedGuestUsersRequest.Builder> listBlockedGuestUsersRequest) Retrieves a paginated list of guest users who have been blocked from a Wickr network.default ListBlockedGuestUsersResponselistBlockedGuestUsers(ListBlockedGuestUsersRequest listBlockedGuestUsersRequest) Retrieves a paginated list of guest users who have been blocked from a Wickr network.default ListBlockedGuestUsersIterablelistBlockedGuestUsersPaginator(Consumer<ListBlockedGuestUsersRequest.Builder> listBlockedGuestUsersRequest) This is a variant oflistBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation.default ListBlockedGuestUsersIterablelistBlockedGuestUsersPaginator(ListBlockedGuestUsersRequest listBlockedGuestUsersRequest) This is a variant oflistBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation.default ListBotsResponselistBots(Consumer<ListBotsRequest.Builder> listBotsRequest) Retrieves a paginated list of bots in a specified Wickr network.default ListBotsResponselistBots(ListBotsRequest listBotsRequest) Retrieves a paginated list of bots in a specified Wickr network.default ListBotsIterablelistBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation.default ListBotsIterablelistBotsPaginator(ListBotsRequest listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation.default ListDevicesForUserResponselistDevicesForUser(Consumer<ListDevicesForUserRequest.Builder> listDevicesForUserRequest) Retrieves a paginated list of devices associated with a specific user in a Wickr network.default ListDevicesForUserResponselistDevicesForUser(ListDevicesForUserRequest listDevicesForUserRequest) Retrieves a paginated list of devices associated with a specific user in a Wickr network.default ListDevicesForUserIterablelistDevicesForUserPaginator(Consumer<ListDevicesForUserRequest.Builder> listDevicesForUserRequest) This is a variant oflistDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation.default ListDevicesForUserIterablelistDevicesForUserPaginator(ListDevicesForUserRequest listDevicesForUserRequest) This is a variant oflistDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation.default ListGuestUsersResponselistGuestUsers(Consumer<ListGuestUsersRequest.Builder> listGuestUsersRequest) Retrieves a paginated list of guest users who have communicated with your Wickr network.default ListGuestUsersResponselistGuestUsers(ListGuestUsersRequest listGuestUsersRequest) Retrieves a paginated list of guest users who have communicated with your Wickr network.default ListGuestUsersIterablelistGuestUsersPaginator(Consumer<ListGuestUsersRequest.Builder> listGuestUsersRequest) This is a variant oflistGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation.default ListGuestUsersIterablelistGuestUsersPaginator(ListGuestUsersRequest listGuestUsersRequest) This is a variant oflistGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation.default ListNetworksResponselistNetworks(Consumer<ListNetworksRequest.Builder> listNetworksRequest) Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account.default ListNetworksResponselistNetworks(ListNetworksRequest listNetworksRequest) Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account.default ListNetworksIterablelistNetworksPaginator(Consumer<ListNetworksRequest.Builder> listNetworksRequest) This is a variant oflistNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation.default ListNetworksIterablelistNetworksPaginator(ListNetworksRequest listNetworksRequest) This is a variant oflistNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation.default ListSecurityGroupsResponselistSecurityGroups(Consumer<ListSecurityGroupsRequest.Builder> listSecurityGroupsRequest) Retrieves a paginated list of security groups in a specified Wickr network.default ListSecurityGroupsResponselistSecurityGroups(ListSecurityGroupsRequest listSecurityGroupsRequest) Retrieves a paginated list of security groups in a specified Wickr network.default ListSecurityGroupsIterablelistSecurityGroupsPaginator(Consumer<ListSecurityGroupsRequest.Builder> listSecurityGroupsRequest) This is a variant oflistSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation.default ListSecurityGroupsIterablelistSecurityGroupsPaginator(ListSecurityGroupsRequest listSecurityGroupsRequest) This is a variant oflistSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation.default ListSecurityGroupUsersResponselistSecurityGroupUsers(Consumer<ListSecurityGroupUsersRequest.Builder> listSecurityGroupUsersRequest) Retrieves a paginated list of users who belong to a specific security group in a Wickr network.default ListSecurityGroupUsersResponselistSecurityGroupUsers(ListSecurityGroupUsersRequest listSecurityGroupUsersRequest) Retrieves a paginated list of users who belong to a specific security group in a Wickr network.default ListSecurityGroupUsersIterablelistSecurityGroupUsersPaginator(Consumer<ListSecurityGroupUsersRequest.Builder> listSecurityGroupUsersRequest) This is a variant oflistSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation.default ListSecurityGroupUsersIterablelistSecurityGroupUsersPaginator(ListSecurityGroupUsersRequest listSecurityGroupUsersRequest) This is a variant oflistSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Retrieves a paginated list of users in a specified Wickr network.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest) Retrieves a paginated list of users in a specified Wickr network.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation.default RegisterOidcConfigResponseregisterOidcConfig(Consumer<RegisterOidcConfigRequest.Builder> registerOidcConfigRequest) Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.default RegisterOidcConfigResponseregisterOidcConfig(RegisterOidcConfigRequest registerOidcConfigRequest) Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.default RegisterOidcConfigTestResponseregisterOidcConfigTest(Consumer<RegisterOidcConfigTestRequest.Builder> registerOidcConfigTestRequest) Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.default RegisterOidcConfigTestResponseregisterOidcConfigTest(RegisterOidcConfigTestRequest registerOidcConfigTestRequest) Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.default WickrServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault UpdateBotResponseupdateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest) Updates the properties of an existing bot in a Wickr network.default UpdateBotResponseupdateBot(UpdateBotRequest updateBotRequest) Updates the properties of an existing bot in a Wickr network.default UpdateDataRetentionResponseupdateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest) Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.default UpdateDataRetentionResponseupdateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.default UpdateGuestUserResponseupdateGuestUser(Consumer<UpdateGuestUserRequest.Builder> updateGuestUserRequest) Updates the block status of a guest user in a Wickr network.default UpdateGuestUserResponseupdateGuestUser(UpdateGuestUserRequest updateGuestUserRequest) Updates the block status of a guest user in a Wickr network.default UpdateNetworkResponseupdateNetwork(Consumer<UpdateNetworkRequest.Builder> updateNetworkRequest) Updates the properties of an existing Wickr network, such as its name or encryption key configuration.default UpdateNetworkResponseupdateNetwork(UpdateNetworkRequest updateNetworkRequest) Updates the properties of an existing Wickr network, such as its name or encryption key configuration.default UpdateNetworkSettingsResponseupdateNetworkSettings(Consumer<UpdateNetworkSettingsRequest.Builder> updateNetworkSettingsRequest) Updates network-level settings for a Wickr network.default UpdateNetworkSettingsResponseupdateNetworkSettings(UpdateNetworkSettingsRequest updateNetworkSettingsRequest) Updates network-level settings for a Wickr network.default UpdateSecurityGroupResponseupdateSecurityGroup(Consumer<UpdateSecurityGroupRequest.Builder> updateSecurityGroupRequest) Updates the properties of an existing security group in a Wickr network, such as its name or settings.default UpdateSecurityGroupResponseupdateSecurityGroup(UpdateSecurityGroupRequest updateSecurityGroupRequest) Updates the properties of an existing security group in a Wickr network, such as its name or settings.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates the properties of an existing user in a Wickr network.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest) Updates the properties of an existing user in a Wickr network.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchCreateUser
default BatchCreateUserResponse batchCreateUser(BatchCreateUserRequest batchCreateUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user.
codeValidation,inviteCode, andinviteCodeTtlare restricted to networks under preview only.- Parameters:
batchCreateUserRequest-- Returns:
- Result of the BatchCreateUser operation returned by the service.
- See Also:
-
batchCreateUser
default BatchCreateUserResponse batchCreateUser(Consumer<BatchCreateUserRequest.Builder> batchCreateUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user.
codeValidation,inviteCode, andinviteCodeTtlare restricted to networks under preview only.
This is a convenience which creates an instance of the
BatchCreateUserRequest.Builderavoiding the need to create one manually viaBatchCreateUserRequest.builder()- Parameters:
batchCreateUserRequest- AConsumerthat will call methods onBatchCreateUserRequest.Builderto create a request.- Returns:
- Result of the BatchCreateUser operation returned by the service.
- See Also:
-
batchDeleteUser
default BatchDeleteUserResponse batchDeleteUser(BatchDeleteUserRequest batchDeleteUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.
- Parameters:
batchDeleteUserRequest-- Returns:
- Result of the BatchDeleteUser operation returned by the service.
- See Also:
-
batchDeleteUser
default BatchDeleteUserResponse batchDeleteUser(Consumer<BatchDeleteUserRequest.Builder> batchDeleteUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.
This is a convenience which creates an instance of the
BatchDeleteUserRequest.Builderavoiding the need to create one manually viaBatchDeleteUserRequest.builder()- Parameters:
batchDeleteUserRequest- AConsumerthat will call methods onBatchDeleteUserRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteUser operation returned by the service.
- See Also:
-
batchLookupUserUname
default BatchLookupUserUnameResponse batchLookupUserUname(BatchLookupUserUnameRequest batchLookupUserUnameRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.
- Parameters:
batchLookupUserUnameRequest-- Returns:
- Result of the BatchLookupUserUname operation returned by the service.
- See Also:
-
batchLookupUserUname
default BatchLookupUserUnameResponse batchLookupUserUname(Consumer<BatchLookupUserUnameRequest.Builder> batchLookupUserUnameRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.
This is a convenience which creates an instance of the
BatchLookupUserUnameRequest.Builderavoiding the need to create one manually viaBatchLookupUserUnameRequest.builder()- Parameters:
batchLookupUserUnameRequest- AConsumerthat will call methods onBatchLookupUserUnameRequest.Builderto create a request.- Returns:
- Result of the BatchLookupUserUname operation returned by the service.
- See Also:
-
batchReinviteUser
default BatchReinviteUserResponse batchReinviteUser(BatchReinviteUserRequest batchReinviteUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.
- Parameters:
batchReinviteUserRequest-- Returns:
- Result of the BatchReinviteUser operation returned by the service.
- See Also:
-
batchReinviteUser
default BatchReinviteUserResponse batchReinviteUser(Consumer<BatchReinviteUserRequest.Builder> batchReinviteUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.
This is a convenience which creates an instance of the
BatchReinviteUserRequest.Builderavoiding the need to create one manually viaBatchReinviteUserRequest.builder()- Parameters:
batchReinviteUserRequest- AConsumerthat will call methods onBatchReinviteUserRequest.Builderto create a request.- Returns:
- Result of the BatchReinviteUser operation returned by the service.
- See Also:
-
batchResetDevicesForUser
default BatchResetDevicesForUserResponse batchResetDevicesForUser(BatchResetDevicesForUserRequest batchResetDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.
- Parameters:
batchResetDevicesForUserRequest-- Returns:
- Result of the BatchResetDevicesForUser operation returned by the service.
- See Also:
-
batchResetDevicesForUser
default BatchResetDevicesForUserResponse batchResetDevicesForUser(Consumer<BatchResetDevicesForUserRequest.Builder> batchResetDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.
This is a convenience which creates an instance of the
BatchResetDevicesForUserRequest.Builderavoiding the need to create one manually viaBatchResetDevicesForUserRequest.builder()- Parameters:
batchResetDevicesForUserRequest- AConsumerthat will call methods onBatchResetDevicesForUserRequest.Builderto create a request.- Returns:
- Result of the BatchResetDevicesForUser operation returned by the service.
- See Also:
-
batchToggleUserSuspendStatus
default BatchToggleUserSuspendStatusResponse batchToggleUserSuspendStatus(BatchToggleUserSuspendStatusRequest batchToggleUserSuspendStatusRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.
- Parameters:
batchToggleUserSuspendStatusRequest-- Returns:
- Result of the BatchToggleUserSuspendStatus operation returned by the service.
- See Also:
-
batchToggleUserSuspendStatus
default BatchToggleUserSuspendStatusResponse batchToggleUserSuspendStatus(Consumer<BatchToggleUserSuspendStatusRequest.Builder> batchToggleUserSuspendStatusRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.
This is a convenience which creates an instance of the
BatchToggleUserSuspendStatusRequest.Builderavoiding the need to create one manually viaBatchToggleUserSuspendStatusRequest.builder()- Parameters:
batchToggleUserSuspendStatusRequest- AConsumerthat will call methods onBatchToggleUserSuspendStatusRequest.Builderto create a request.- Returns:
- Result of the BatchToggleUserSuspendStatus operation returned by the service.
- See Also:
-
createBot
default CreateBotResponse createBot(CreateBotRequest createBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.
- Parameters:
createBotRequest-- Returns:
- Result of the CreateBot operation returned by the service.
- See Also:
-
createBot
default CreateBotResponse createBot(Consumer<CreateBotRequest.Builder> createBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.
This is a convenience which creates an instance of the
CreateBotRequest.Builderavoiding the need to create one manually viaCreateBotRequest.builder()- Parameters:
createBotRequest- AConsumerthat will call methods onCreateBotRequest.Builderto create a request.- Returns:
- Result of the CreateBot operation returned by the service.
- See Also:
-
createDataRetentionBot
default CreateDataRetentionBotResponse createDataRetentionBot(CreateDataRetentionBotRequest createDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.
- Parameters:
createDataRetentionBotRequest-- Returns:
- Result of the CreateDataRetentionBot operation returned by the service.
- See Also:
-
createDataRetentionBot
default CreateDataRetentionBotResponse createDataRetentionBot(Consumer<CreateDataRetentionBotRequest.Builder> createDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.
This is a convenience which creates an instance of the
CreateDataRetentionBotRequest.Builderavoiding the need to create one manually viaCreateDataRetentionBotRequest.builder()- Parameters:
createDataRetentionBotRequest- AConsumerthat will call methods onCreateDataRetentionBotRequest.Builderto create a request.- Returns:
- Result of the CreateDataRetentionBot operation returned by the service.
- See Also:
-
createDataRetentionBotChallenge
default CreateDataRetentionBotChallengeResponse createDataRetentionBotChallenge(CreateDataRetentionBotChallengeRequest createDataRetentionBotChallengeRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.
- Parameters:
createDataRetentionBotChallengeRequest-- Returns:
- Result of the CreateDataRetentionBotChallenge operation returned by the service.
- See Also:
-
createDataRetentionBotChallenge
default CreateDataRetentionBotChallengeResponse createDataRetentionBotChallenge(Consumer<CreateDataRetentionBotChallengeRequest.Builder> createDataRetentionBotChallengeRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.
This is a convenience which creates an instance of the
CreateDataRetentionBotChallengeRequest.Builderavoiding the need to create one manually viaCreateDataRetentionBotChallengeRequest.builder()- Parameters:
createDataRetentionBotChallengeRequest- AConsumerthat will call methods onCreateDataRetentionBotChallengeRequest.Builderto create a request.- Returns:
- Result of the CreateDataRetentionBotChallenge operation returned by the service.
- See Also:
-
createNetwork
default CreateNetworkResponse createNetwork(CreateNetworkRequest createNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.
- Parameters:
createNetworkRequest-- Returns:
- Result of the CreateNetwork operation returned by the service.
- See Also:
-
createNetwork
default CreateNetworkResponse createNetwork(Consumer<CreateNetworkRequest.Builder> createNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.
This is a convenience which creates an instance of the
CreateNetworkRequest.Builderavoiding the need to create one manually viaCreateNetworkRequest.builder()- Parameters:
createNetworkRequest- AConsumerthat will call methods onCreateNetworkRequest.Builderto create a request.- Returns:
- Result of the CreateNetwork operation returned by the service.
- See Also:
-
createSecurityGroup
default CreateSecurityGroupResponse createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.
- Parameters:
createSecurityGroupRequest-- Returns:
- Result of the CreateSecurityGroup operation returned by the service.
- See Also:
-
createSecurityGroup
default CreateSecurityGroupResponse createSecurityGroup(Consumer<CreateSecurityGroupRequest.Builder> createSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.
This is a convenience which creates an instance of the
CreateSecurityGroupRequest.Builderavoiding the need to create one manually viaCreateSecurityGroupRequest.builder()- Parameters:
createSecurityGroupRequest- AConsumerthat will call methods onCreateSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the CreateSecurityGroup operation returned by the service.
- See Also:
-
deleteBot
default DeleteBotResponse deleteBot(DeleteBotRequest deleteBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.
- Parameters:
deleteBotRequest-- Returns:
- Result of the DeleteBot operation returned by the service.
- See Also:
-
deleteBot
default DeleteBotResponse deleteBot(Consumer<DeleteBotRequest.Builder> deleteBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.
This is a convenience which creates an instance of the
DeleteBotRequest.Builderavoiding the need to create one manually viaDeleteBotRequest.builder()- Parameters:
deleteBotRequest- AConsumerthat will call methods onDeleteBotRequest.Builderto create a request.- Returns:
- Result of the DeleteBot operation returned by the service.
- See Also:
-
deleteDataRetentionBot
default DeleteDataRetentionBotResponse deleteDataRetentionBot(DeleteDataRetentionBotRequest deleteDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.
- Parameters:
deleteDataRetentionBotRequest-- Returns:
- Result of the DeleteDataRetentionBot operation returned by the service.
- See Also:
-
deleteDataRetentionBot
default DeleteDataRetentionBotResponse deleteDataRetentionBot(Consumer<DeleteDataRetentionBotRequest.Builder> deleteDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.
This is a convenience which creates an instance of the
DeleteDataRetentionBotRequest.Builderavoiding the need to create one manually viaDeleteDataRetentionBotRequest.builder()- Parameters:
deleteDataRetentionBotRequest- AConsumerthat will call methods onDeleteDataRetentionBotRequest.Builderto create a request.- Returns:
- Result of the DeleteDataRetentionBot operation returned by the service.
- See Also:
-
deleteNetwork
default DeleteNetworkResponse deleteNetwork(DeleteNetworkRequest deleteNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.
- Parameters:
deleteNetworkRequest-- Returns:
- Result of the DeleteNetwork operation returned by the service.
- See Also:
-
deleteNetwork
default DeleteNetworkResponse deleteNetwork(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.
This is a convenience which creates an instance of the
DeleteNetworkRequest.Builderavoiding the need to create one manually viaDeleteNetworkRequest.builder()- Parameters:
deleteNetworkRequest- AConsumerthat will call methods onDeleteNetworkRequest.Builderto create a request.- Returns:
- Result of the DeleteNetwork operation returned by the service.
- See Also:
-
deleteSecurityGroup
default DeleteSecurityGroupResponse deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.
- Parameters:
deleteSecurityGroupRequest-- Returns:
- Result of the DeleteSecurityGroup operation returned by the service.
- See Also:
-
deleteSecurityGroup
default DeleteSecurityGroupResponse deleteSecurityGroup(Consumer<DeleteSecurityGroupRequest.Builder> deleteSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.
This is a convenience which creates an instance of the
DeleteSecurityGroupRequest.Builderavoiding the need to create one manually viaDeleteSecurityGroupRequest.builder()- Parameters:
deleteSecurityGroupRequest- AConsumerthat will call methods onDeleteSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteSecurityGroup operation returned by the service.
- See Also:
-
getBot
default GetBotResponse getBot(GetBotRequest getBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.
- Parameters:
getBotRequest-- Returns:
- Result of the GetBot operation returned by the service.
- See Also:
-
getBot
default GetBotResponse getBot(Consumer<GetBotRequest.Builder> getBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.
This is a convenience which creates an instance of the
GetBotRequest.Builderavoiding the need to create one manually viaGetBotRequest.builder()- Parameters:
getBotRequest- AConsumerthat will call methods onGetBotRequest.Builderto create a request.- Returns:
- Result of the GetBot operation returned by the service.
- See Also:
-
getBotsCount
default GetBotsCountResponse getBotsCount(GetBotsCountRequest getBotsCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).
- Parameters:
getBotsCountRequest-- Returns:
- Result of the GetBotsCount operation returned by the service.
- See Also:
-
getBotsCount
default GetBotsCountResponse getBotsCount(Consumer<GetBotsCountRequest.Builder> getBotsCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).
This is a convenience which creates an instance of the
GetBotsCountRequest.Builderavoiding the need to create one manually viaGetBotsCountRequest.builder()- Parameters:
getBotsCountRequest- AConsumerthat will call methods onGetBotsCountRequest.Builderto create a request.- Returns:
- Result of the GetBotsCount operation returned by the service.
- See Also:
-
getDataRetentionBot
default GetDataRetentionBotResponse getDataRetentionBot(GetDataRetentionBotRequest getDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.
- Parameters:
getDataRetentionBotRequest-- Returns:
- Result of the GetDataRetentionBot operation returned by the service.
- See Also:
-
getDataRetentionBot
default GetDataRetentionBotResponse getDataRetentionBot(Consumer<GetDataRetentionBotRequest.Builder> getDataRetentionBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.
This is a convenience which creates an instance of the
GetDataRetentionBotRequest.Builderavoiding the need to create one manually viaGetDataRetentionBotRequest.builder()- Parameters:
getDataRetentionBotRequest- AConsumerthat will call methods onGetDataRetentionBotRequest.Builderto create a request.- Returns:
- Result of the GetDataRetentionBot operation returned by the service.
- See Also:
-
getGuestUserHistoryCount
default GetGuestUserHistoryCountResponse getGuestUserHistoryCount(GetGuestUserHistoryCountRequest getGuestUserHistoryCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.
- Parameters:
getGuestUserHistoryCountRequest-- Returns:
- Result of the GetGuestUserHistoryCount operation returned by the service.
- See Also:
-
getGuestUserHistoryCount
default GetGuestUserHistoryCountResponse getGuestUserHistoryCount(Consumer<GetGuestUserHistoryCountRequest.Builder> getGuestUserHistoryCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.
This is a convenience which creates an instance of the
GetGuestUserHistoryCountRequest.Builderavoiding the need to create one manually viaGetGuestUserHistoryCountRequest.builder()- Parameters:
getGuestUserHistoryCountRequest- AConsumerthat will call methods onGetGuestUserHistoryCountRequest.Builderto create a request.- Returns:
- Result of the GetGuestUserHistoryCount operation returned by the service.
- See Also:
-
getNetwork
default GetNetworkResponse getNetwork(GetNetworkRequest getNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
- Parameters:
getNetworkRequest-- Returns:
- Result of the GetNetwork operation returned by the service.
- See Also:
-
getNetwork
default GetNetworkResponse getNetwork(Consumer<GetNetworkRequest.Builder> getNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
This is a convenience which creates an instance of the
GetNetworkRequest.Builderavoiding the need to create one manually viaGetNetworkRequest.builder()- Parameters:
getNetworkRequest- AConsumerthat will call methods onGetNetworkRequest.Builderto create a request.- Returns:
- Result of the GetNetwork operation returned by the service.
- See Also:
-
getNetworkSettings
default GetNetworkSettingsResponse getNetworkSettings(GetNetworkSettingsRequest getNetworkSettingsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.
- Parameters:
getNetworkSettingsRequest-- Returns:
- Result of the GetNetworkSettings operation returned by the service.
- See Also:
-
getNetworkSettings
default GetNetworkSettingsResponse getNetworkSettings(Consumer<GetNetworkSettingsRequest.Builder> getNetworkSettingsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.
This is a convenience which creates an instance of the
GetNetworkSettingsRequest.Builderavoiding the need to create one manually viaGetNetworkSettingsRequest.builder()- Parameters:
getNetworkSettingsRequest- AConsumerthat will call methods onGetNetworkSettingsRequest.Builderto create a request.- Returns:
- Result of the GetNetworkSettings operation returned by the service.
- See Also:
-
getOidcInfo
default GetOidcInfoResponse getOidcInfo(GetOidcInfoRequest getOidcInfoRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.
- Parameters:
getOidcInfoRequest-- Returns:
- Result of the GetOidcInfo operation returned by the service.
- See Also:
-
getOidcInfo
default GetOidcInfoResponse getOidcInfo(Consumer<GetOidcInfoRequest.Builder> getOidcInfoRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.
This is a convenience which creates an instance of the
GetOidcInfoRequest.Builderavoiding the need to create one manually viaGetOidcInfoRequest.builder()- Parameters:
getOidcInfoRequest- AConsumerthat will call methods onGetOidcInfoRequest.Builderto create a request.- Returns:
- Result of the GetOidcInfo operation returned by the service.
- See Also:
-
getSecurityGroup
default GetSecurityGroupResponse getSecurityGroup(GetSecurityGroupRequest getSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.
- Parameters:
getSecurityGroupRequest-- Returns:
- Result of the GetSecurityGroup operation returned by the service.
- See Also:
-
getSecurityGroup
default GetSecurityGroupResponse getSecurityGroup(Consumer<GetSecurityGroupRequest.Builder> getSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.
This is a convenience which creates an instance of the
GetSecurityGroupRequest.Builderavoiding the need to create one manually viaGetSecurityGroupRequest.builder()- Parameters:
getSecurityGroupRequest- AConsumerthat will call methods onGetSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the GetSecurityGroup operation returned by the service.
- See Also:
-
getUser
default GetUserResponse getUser(GetUserRequest getUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.
- Parameters:
getUserRequest-- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
-
getUser
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.
This is a convenience which creates an instance of the
GetUserRequest.Builderavoiding the need to create one manually viaGetUserRequest.builder()- Parameters:
getUserRequest- AConsumerthat will call methods onGetUserRequest.Builderto create a request.- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
-
getUsersCount
default GetUsersCountResponse getUsersCount(GetUsersCountRequest getUsersCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.
- Parameters:
getUsersCountRequest-- Returns:
- Result of the GetUsersCount operation returned by the service.
- See Also:
-
getUsersCount
default GetUsersCountResponse getUsersCount(Consumer<GetUsersCountRequest.Builder> getUsersCountRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.
This is a convenience which creates an instance of the
GetUsersCountRequest.Builderavoiding the need to create one manually viaGetUsersCountRequest.builder()- Parameters:
getUsersCountRequest- AConsumerthat will call methods onGetUsersCountRequest.Builderto create a request.- Returns:
- Result of the GetUsersCount operation returned by the service.
- See Also:
-
listBlockedGuestUsers
default ListBlockedGuestUsersResponse listBlockedGuestUsers(ListBlockedGuestUsersRequest listBlockedGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.
- Parameters:
listBlockedGuestUsersRequest-- Returns:
- Result of the ListBlockedGuestUsers operation returned by the service.
- See Also:
-
listBlockedGuestUsers
default ListBlockedGuestUsersResponse listBlockedGuestUsers(Consumer<ListBlockedGuestUsersRequest.Builder> listBlockedGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.
This is a convenience which creates an instance of the
ListBlockedGuestUsersRequest.Builderavoiding the need to create one manually viaListBlockedGuestUsersRequest.builder()- Parameters:
listBlockedGuestUsersRequest- AConsumerthat will call methods onListBlockedGuestUsersRequest.Builderto create a request.- Returns:
- Result of the ListBlockedGuestUsers operation returned by the service.
- See Also:
-
listBlockedGuestUsersPaginator
default ListBlockedGuestUsersIterable listBlockedGuestUsersPaginator(ListBlockedGuestUsersRequest listBlockedGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client.listBlockedGuestUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client .listBlockedGuestUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client.listBlockedGuestUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation.- Parameters:
listBlockedGuestUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBlockedGuestUsersPaginator
default ListBlockedGuestUsersIterable listBlockedGuestUsersPaginator(Consumer<ListBlockedGuestUsersRequest.Builder> listBlockedGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client.listBlockedGuestUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client .listBlockedGuestUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListBlockedGuestUsersIterable responses = client.listBlockedGuestUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBlockedGuestUsers(software.amazon.awssdk.services.wickr.model.ListBlockedGuestUsersRequest)operation.
This is a convenience which creates an instance of the
ListBlockedGuestUsersRequest.Builderavoiding the need to create one manually viaListBlockedGuestUsersRequest.builder()- Parameters:
listBlockedGuestUsersRequest- AConsumerthat will call methods onListBlockedGuestUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBots
default ListBotsResponse listBots(ListBotsRequest listBotsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.
- Parameters:
listBotsRequest-- Returns:
- Result of the ListBots operation returned by the service.
- See Also:
-
listBots
default ListBotsResponse listBots(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.
This is a convenience which creates an instance of the
ListBotsRequest.Builderavoiding the need to create one manually viaListBotsRequest.builder()- Parameters:
listBotsRequest- AConsumerthat will call methods onListBotsRequest.Builderto create a request.- Returns:
- Result of the ListBots operation returned by the service.
- See Also:
-
listBotsPaginator
default ListBotsIterable listBotsPaginator(ListBotsRequest listBotsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListBotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation.- Parameters:
listBotsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBotsPaginator
default ListBotsIterable listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListBotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.wickr.model.ListBotsRequest)operation.
This is a convenience which creates an instance of the
ListBotsRequest.Builderavoiding the need to create one manually viaListBotsRequest.builder()- Parameters:
listBotsRequest- AConsumerthat will call methods onListBotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDevicesForUser
default ListDevicesForUserResponse listDevicesForUser(ListDevicesForUserRequest listDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.
- Parameters:
listDevicesForUserRequest-- Returns:
- Result of the ListDevicesForUser operation returned by the service.
- See Also:
-
listDevicesForUser
default ListDevicesForUserResponse listDevicesForUser(Consumer<ListDevicesForUserRequest.Builder> listDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.
This is a convenience which creates an instance of the
ListDevicesForUserRequest.Builderavoiding the need to create one manually viaListDevicesForUserRequest.builder()- Parameters:
listDevicesForUserRequest- AConsumerthat will call methods onListDevicesForUserRequest.Builderto create a request.- Returns:
- Result of the ListDevicesForUser operation returned by the service.
- See Also:
-
listDevicesForUserPaginator
default ListDevicesForUserIterable listDevicesForUserPaginator(ListDevicesForUserRequest listDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client.listDevicesForUserPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client .listDevicesForUserPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListDevicesForUserResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client.listDevicesForUserPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation.- Parameters:
listDevicesForUserRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDevicesForUserPaginator
default ListDevicesForUserIterable listDevicesForUserPaginator(Consumer<ListDevicesForUserRequest.Builder> listDevicesForUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client.listDevicesForUserPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client .listDevicesForUserPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListDevicesForUserResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListDevicesForUserIterable responses = client.listDevicesForUserPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicesForUser(software.amazon.awssdk.services.wickr.model.ListDevicesForUserRequest)operation.
This is a convenience which creates an instance of the
ListDevicesForUserRequest.Builderavoiding the need to create one manually viaListDevicesForUserRequest.builder()- Parameters:
listDevicesForUserRequest- AConsumerthat will call methods onListDevicesForUserRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGuestUsers
default ListGuestUsersResponse listGuestUsers(ListGuestUsersRequest listGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.
- Parameters:
listGuestUsersRequest-- Returns:
- Result of the ListGuestUsers operation returned by the service.
- See Also:
-
listGuestUsers
default ListGuestUsersResponse listGuestUsers(Consumer<ListGuestUsersRequest.Builder> listGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.
This is a convenience which creates an instance of the
ListGuestUsersRequest.Builderavoiding the need to create one manually viaListGuestUsersRequest.builder()- Parameters:
listGuestUsersRequest- AConsumerthat will call methods onListGuestUsersRequest.Builderto create a request.- Returns:
- Result of the ListGuestUsers operation returned by the service.
- See Also:
-
listGuestUsersPaginator
default ListGuestUsersIterable listGuestUsersPaginator(ListGuestUsersRequest listGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListGuestUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation.- Parameters:
listGuestUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGuestUsersPaginator
default ListGuestUsersIterable listGuestUsersPaginator(Consumer<ListGuestUsersRequest.Builder> listGuestUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListGuestUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListGuestUsersIterable responses = client.listGuestUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGuestUsers(software.amazon.awssdk.services.wickr.model.ListGuestUsersRequest)operation.
This is a convenience which creates an instance of the
ListGuestUsersRequest.Builderavoiding the need to create one manually viaListGuestUsersRequest.builder()- Parameters:
listGuestUsersRequest- AConsumerthat will call methods onListGuestUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listNetworks
default ListNetworksResponse listNetworks(ListNetworksRequest listNetworksRequest) throws ValidationErrorException, BadRequestErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.
- Parameters:
listNetworksRequest-- Returns:
- Result of the ListNetworks operation returned by the service.
- See Also:
-
listNetworks
default ListNetworksResponse listNetworks(Consumer<ListNetworksRequest.Builder> listNetworksRequest) throws ValidationErrorException, BadRequestErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.
This is a convenience which creates an instance of the
ListNetworksRequest.Builderavoiding the need to create one manually viaListNetworksRequest.builder()- Parameters:
listNetworksRequest- AConsumerthat will call methods onListNetworksRequest.Builderto create a request.- Returns:
- Result of the ListNetworks operation returned by the service.
- See Also:
-
listNetworksPaginator
default ListNetworksIterable listNetworksPaginator(ListNetworksRequest listNetworksRequest) throws ValidationErrorException, BadRequestErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListNetworksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation.- Parameters:
listNetworksRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listNetworksPaginator
default ListNetworksIterable listNetworksPaginator(Consumer<ListNetworksRequest.Builder> listNetworksRequest) throws ValidationErrorException, BadRequestErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListNetworksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNetworks(software.amazon.awssdk.services.wickr.model.ListNetworksRequest)operation.
This is a convenience which creates an instance of the
ListNetworksRequest.Builderavoiding the need to create one manually viaListNetworksRequest.builder()- Parameters:
listNetworksRequest- AConsumerthat will call methods onListNetworksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityGroupUsers
default ListSecurityGroupUsersResponse listSecurityGroupUsers(ListSecurityGroupUsersRequest listSecurityGroupUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of users who belong to a specific security group in a Wickr network.
- Parameters:
listSecurityGroupUsersRequest-- Returns:
- Result of the ListSecurityGroupUsers operation returned by the service.
- See Also:
-
listSecurityGroupUsers
default ListSecurityGroupUsersResponse listSecurityGroupUsers(Consumer<ListSecurityGroupUsersRequest.Builder> listSecurityGroupUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of users who belong to a specific security group in a Wickr network.
This is a convenience which creates an instance of the
ListSecurityGroupUsersRequest.Builderavoiding the need to create one manually viaListSecurityGroupUsersRequest.builder()- Parameters:
listSecurityGroupUsersRequest- AConsumerthat will call methods onListSecurityGroupUsersRequest.Builderto create a request.- Returns:
- Result of the ListSecurityGroupUsers operation returned by the service.
- See Also:
-
listSecurityGroupUsersPaginator
default ListSecurityGroupUsersIterable listSecurityGroupUsersPaginator(ListSecurityGroupUsersRequest listSecurityGroupUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client.listSecurityGroupUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client .listSecurityGroupUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client.listSecurityGroupUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation.- Parameters:
listSecurityGroupUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityGroupUsersPaginator
default ListSecurityGroupUsersIterable listSecurityGroupUsersPaginator(Consumer<ListSecurityGroupUsersRequest.Builder> listSecurityGroupUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client.listSecurityGroupUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client .listSecurityGroupUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupUsersIterable responses = client.listSecurityGroupUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityGroupUsers(software.amazon.awssdk.services.wickr.model.ListSecurityGroupUsersRequest)operation.
This is a convenience which creates an instance of the
ListSecurityGroupUsersRequest.Builderavoiding the need to create one manually viaListSecurityGroupUsersRequest.builder()- Parameters:
listSecurityGroupUsersRequest- AConsumerthat will call methods onListSecurityGroupUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityGroups
default ListSecurityGroupsResponse listSecurityGroups(ListSecurityGroupsRequest listSecurityGroupsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.
- Parameters:
listSecurityGroupsRequest-- Returns:
- Result of the ListSecurityGroups operation returned by the service.
- See Also:
-
listSecurityGroups
default ListSecurityGroupsResponse listSecurityGroups(Consumer<ListSecurityGroupsRequest.Builder> listSecurityGroupsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.
This is a convenience which creates an instance of the
ListSecurityGroupsRequest.Builderavoiding the need to create one manually viaListSecurityGroupsRequest.builder()- Parameters:
listSecurityGroupsRequest- AConsumerthat will call methods onListSecurityGroupsRequest.Builderto create a request.- Returns:
- Result of the ListSecurityGroups operation returned by the service.
- See Also:
-
listSecurityGroupsPaginator
default ListSecurityGroupsIterable listSecurityGroupsPaginator(ListSecurityGroupsRequest listSecurityGroupsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client.listSecurityGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client .listSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client.listSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation.- Parameters:
listSecurityGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityGroupsPaginator
default ListSecurityGroupsIterable listSecurityGroupsPaginator(Consumer<ListSecurityGroupsRequest.Builder> listSecurityGroupsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client.listSecurityGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client .listSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListSecurityGroupsIterable responses = client.listSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityGroups(software.amazon.awssdk.services.wickr.model.ListSecurityGroupsRequest)operation.
This is a convenience which creates an instance of the
ListSecurityGroupsRequest.Builderavoiding the need to create one manually viaListSecurityGroupsRequest.builder()- Parameters:
listSecurityGroupsRequest- AConsumerthat will call methods onListSecurityGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.
- Parameters:
listUsersRequest-- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException This is a variant of
listUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.wickr.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wickr.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.wickr.model.ListUsersRequest)operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
registerOidcConfig
default RegisterOidcConfigResponse registerOidcConfig(RegisterOidcConfigRequest registerOidcConfigRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.
- Parameters:
registerOidcConfigRequest-- Returns:
- Result of the RegisterOidcConfig operation returned by the service.
- See Also:
-
registerOidcConfig
default RegisterOidcConfigResponse registerOidcConfig(Consumer<RegisterOidcConfigRequest.Builder> registerOidcConfigRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.
This is a convenience which creates an instance of the
RegisterOidcConfigRequest.Builderavoiding the need to create one manually viaRegisterOidcConfigRequest.builder()- Parameters:
registerOidcConfigRequest- AConsumerthat will call methods onRegisterOidcConfigRequest.Builderto create a request.- Returns:
- Result of the RegisterOidcConfig operation returned by the service.
- See Also:
-
registerOidcConfigTest
default RegisterOidcConfigTestResponse registerOidcConfigTest(RegisterOidcConfigTestRequest registerOidcConfigTestRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.
- Parameters:
registerOidcConfigTestRequest-- Returns:
- Result of the RegisterOidcConfigTest operation returned by the service.
- See Also:
-
registerOidcConfigTest
default RegisterOidcConfigTestResponse registerOidcConfigTest(Consumer<RegisterOidcConfigTestRequest.Builder> registerOidcConfigTestRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.
This is a convenience which creates an instance of the
RegisterOidcConfigTestRequest.Builderavoiding the need to create one manually viaRegisterOidcConfigTestRequest.builder()- Parameters:
registerOidcConfigTestRequest- AConsumerthat will call methods onRegisterOidcConfigTestRequest.Builderto create a request.- Returns:
- Result of the RegisterOidcConfigTest operation returned by the service.
- See Also:
-
updateBot
default UpdateBotResponse updateBot(UpdateBotRequest updateBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.
- Parameters:
updateBotRequest-- Returns:
- Result of the UpdateBot operation returned by the service.
- See Also:
-
updateBot
default UpdateBotResponse updateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.
This is a convenience which creates an instance of the
UpdateBotRequest.Builderavoiding the need to create one manually viaUpdateBotRequest.builder()- Parameters:
updateBotRequest- AConsumerthat will call methods onUpdateBotRequest.Builderto create a request.- Returns:
- Result of the UpdateBot operation returned by the service.
- See Also:
-
updateDataRetention
default UpdateDataRetentionResponse updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.
- Parameters:
updateDataRetentionRequest-- Returns:
- Result of the UpdateDataRetention operation returned by the service.
- See Also:
-
updateDataRetention
default UpdateDataRetentionResponse updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.
This is a convenience which creates an instance of the
UpdateDataRetentionRequest.Builderavoiding the need to create one manually viaUpdateDataRetentionRequest.builder()- Parameters:
updateDataRetentionRequest- AConsumerthat will call methods onUpdateDataRetentionRequest.Builderto create a request.- Returns:
- Result of the UpdateDataRetention operation returned by the service.
- See Also:
-
updateGuestUser
default UpdateGuestUserResponse updateGuestUser(UpdateGuestUserRequest updateGuestUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.
- Parameters:
updateGuestUserRequest-- Returns:
- Result of the UpdateGuestUser operation returned by the service.
- See Also:
-
updateGuestUser
default UpdateGuestUserResponse updateGuestUser(Consumer<UpdateGuestUserRequest.Builder> updateGuestUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.
This is a convenience which creates an instance of the
UpdateGuestUserRequest.Builderavoiding the need to create one manually viaUpdateGuestUserRequest.builder()- Parameters:
updateGuestUserRequest- AConsumerthat will call methods onUpdateGuestUserRequest.Builderto create a request.- Returns:
- Result of the UpdateGuestUser operation returned by the service.
- See Also:
-
updateNetwork
default UpdateNetworkResponse updateNetwork(UpdateNetworkRequest updateNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing Wickr network, such as its name or encryption key configuration.
- Parameters:
updateNetworkRequest-- Returns:
- Result of the UpdateNetwork operation returned by the service.
- See Also:
-
updateNetwork
default UpdateNetworkResponse updateNetwork(Consumer<UpdateNetworkRequest.Builder> updateNetworkRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing Wickr network, such as its name or encryption key configuration.
This is a convenience which creates an instance of the
UpdateNetworkRequest.Builderavoiding the need to create one manually viaUpdateNetworkRequest.builder()- Parameters:
updateNetworkRequest- AConsumerthat will call methods onUpdateNetworkRequest.Builderto create a request.- Returns:
- Result of the UpdateNetwork operation returned by the service.
- See Also:
-
updateNetworkSettings
default UpdateNetworkSettingsResponse updateNetworkSettings(UpdateNetworkSettingsRequest updateNetworkSettingsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.
- Parameters:
updateNetworkSettingsRequest-- Returns:
- Result of the UpdateNetworkSettings operation returned by the service.
- See Also:
-
updateNetworkSettings
default UpdateNetworkSettingsResponse updateNetworkSettings(Consumer<UpdateNetworkSettingsRequest.Builder> updateNetworkSettingsRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.
This is a convenience which creates an instance of the
UpdateNetworkSettingsRequest.Builderavoiding the need to create one manually viaUpdateNetworkSettingsRequest.builder()- Parameters:
updateNetworkSettingsRequest- AConsumerthat will call methods onUpdateNetworkSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdateNetworkSettings operation returned by the service.
- See Also:
-
updateSecurityGroup
default UpdateSecurityGroupResponse updateSecurityGroup(UpdateSecurityGroupRequest updateSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing security group in a Wickr network, such as its name or settings.
- Parameters:
updateSecurityGroupRequest-- Returns:
- Result of the UpdateSecurityGroup operation returned by the service.
- See Also:
-
updateSecurityGroup
default UpdateSecurityGroupResponse updateSecurityGroup(Consumer<UpdateSecurityGroupRequest.Builder> updateSecurityGroupRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing security group in a Wickr network, such as its name or settings.
This is a convenience which creates an instance of the
UpdateSecurityGroupRequest.Builderavoiding the need to create one manually viaUpdateSecurityGroupRequest.builder()- Parameters:
updateSecurityGroupRequest- AConsumerthat will call methods onUpdateSecurityGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateSecurityGroup operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing user in a Wickr network. This operation allows you to modify the user's name, password, security group membership, and invite code settings.
codeValidation,inviteCode, andinviteCodeTtlare restricted to networks under preview only.- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ValidationErrorException, BadRequestErrorException, ResourceNotFoundErrorException, ForbiddenErrorException, UnauthorizedErrorException, InternalServerErrorException, RateLimitErrorException, AwsServiceException, SdkClientException, WickrException Updates the properties of an existing user in a Wickr network. This operation allows you to modify the user's name, password, security group membership, and invite code settings.
codeValidation,inviteCode, andinviteCodeTtlare restricted to networks under preview only.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
create
Create aWickrClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aWickrClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-