@aws-sdk/client-workmail 3.682.0 → 3.683.0

package/dist-types/models/models_0.d.ts

@@ -666,6 +666,48 @@ export declare class ReservedNameException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ReservedNameException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface CreateIdentityCenterApplicationRequest {
+    /**
+     * <p>
+     *          The name of the IAM Identity Center application.
+     *
+     *
+     *       </p>
+     * @public
+     */
+    Name: string | undefined;
+    /**
+     * <p>
+     *          The Amazon Resource Name (ARN) of the instance.
+     *       </p>
+     * @public
+     */
+    InstanceArn: string | undefined;
+    /**
+     * <p>
+     *          The idempotency token associated with the request.
+     *
+     *
+     *       </p>
+     * @public
+     */
+    ClientToken?: string;
+}
+/**
+ * @public
+ */
+export interface CreateIdentityCenterApplicationResponse {
+    /**
+     * <p>
+     *          The Amazon Resource Name (ARN) of the application.
+     *       </p>
+     * @public
+     */
+    ApplicationArn?: string;
+}
 /**
  * <p>The rules for the given impersonation role.</p>
  * @public
@@ -1043,6 +1085,11 @@ export interface CreateUserRequest {
      * @public
      */
     HiddenFromGlobalAddressList?: boolean;
+    /**
+     * <p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>
+     * @public
+     */
+    IdentityProviderUserId?: string;
 }
 /**
  * @public
@@ -1208,6 +1255,39 @@ export interface DeleteGroupRequest {
  */
 export interface DeleteGroupResponse {
 }
+/**
+ * @public
+ */
+export interface DeleteIdentityCenterApplicationRequest {
+    /**
+     * <p>
+     *          The Amazon Resource Name (ARN) of the application.
+     *       </p>
+     * @public
+     */
+    ApplicationArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteIdentityCenterApplicationResponse {
+}
+/**
+ * @public
+ */
+export interface DeleteIdentityProviderConfigurationRequest {
+    /**
+     * <p>
+     * The Organization ID. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteIdentityProviderConfigurationResponse {
+}
 /**
  * @public
  */
@@ -1361,6 +1441,11 @@ export interface DeleteOrganizationRequest {
      * @public
      */
     ForceDelete?: boolean;
+    /**
+     * <p>Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.</p>
+     * @public
+     */
+    DeleteIdentityCenterApplication?: boolean;
 }
 /**
  * @public
@@ -1377,6 +1462,28 @@ export interface DeleteOrganizationResponse {
      */
     State?: string;
 }
+/**
+ * @public
+ */
+export interface DeletePersonalAccessTokenRequest {
+    /**
+     * <p>
+     *          The Organization ID. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+    /**
+     * <p>
+     *         The Personal Access Token ID.</p>
+     * @public
+     */
+    PersonalAccessTokenId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePersonalAccessTokenResponse {
+}
 /**
  * @public
  */
@@ -1691,6 +1798,120 @@ export interface DescribeGroupResponse {
      */
     HiddenFromGlobalAddressList?: boolean;
 }
+/**
+ * @public
+ */
+export interface DescribeIdentityProviderConfigurationRequest {
+    /**
+     * <p>
+     *          The Organization ID. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const IdentityProviderAuthenticationMode: {
+    readonly IDENTITY_PROVIDER_AND_DIRECTORY: "IDENTITY_PROVIDER_AND_DIRECTORY";
+    readonly IDENTITY_PROVIDER_ONLY: "IDENTITY_PROVIDER_ONLY";
+};
+/**
+ * @public
+ */
+export type IdentityProviderAuthenticationMode = (typeof IdentityProviderAuthenticationMode)[keyof typeof IdentityProviderAuthenticationMode];
+/**
+ * <p>
+ *          The IAM Identity Center configuration.
+ *       </p>
+ * @public
+ */
+export interface IdentityCenterConfiguration {
+    /**
+     * <p>
+     *          The Amazon Resource Name (ARN) of the  of IAM Identity Center instance. Must be in the same AWS account and region as WorkMail organization.</p>
+     * @public
+     */
+    InstanceArn: string | undefined;
+    /**
+     * <p>
+     *          The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail. Must be created by the WorkMail API, see CreateIdentityCenterApplication.</p>
+     * @public
+     */
+    ApplicationArn: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const PersonalAccessTokenConfigurationStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type PersonalAccessTokenConfigurationStatus = (typeof PersonalAccessTokenConfigurationStatus)[keyof typeof PersonalAccessTokenConfigurationStatus];
+/**
+ * <p>
+ *          Displays the Personal Access Token status.
+ *       </p>
+ * @public
+ */
+export interface PersonalAccessTokenConfiguration {
+    /**
+     * <p>
+     *          The status of the Personal Access Token allowed for the organization.
+     *       </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <i>Active</i> - Mailbox users can login to the web application and choose <i>Settings</i> to see the new <i>Personal Access Tokens</i> page to
+     *             create and delete the Personal Access Tokens. Mailbox users can use the Personal Access Tokens to set up mailbox connection from desktop or mobile email clients.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>Inactive</i> - Personal Access Tokens are disabled for your organization. Mailbox users can’t create, list, or delete Personal Access Tokens and can’t use them to connect to
+     *             their mailboxes from desktop or mobile email clients.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    Status: PersonalAccessTokenConfigurationStatus | undefined;
+    /**
+     * <p>
+     *         The validity of the Personal Access Token status in days.
+     *       </p>
+     * @public
+     */
+    LifetimeInDays?: number;
+}
+/**
+ * @public
+ */
+export interface DescribeIdentityProviderConfigurationResponse {
+    /**
+     * <p>
+     * The authentication mode used in WorkMail.</p>
+     * @public
+     */
+    AuthenticationMode?: IdentityProviderAuthenticationMode;
+    /**
+     * <p>
+     *          The details of the IAM Identity Center configuration.
+     *       </p>
+     * @public
+     */
+    IdentityCenterConfiguration?: IdentityCenterConfiguration;
+    /**
+     * <p>
+     *          The details of the Personal Access Token configuration.
+     *       </p>
+     * @public
+     */
+    PersonalAccessTokenConfiguration?: PersonalAccessTokenConfiguration;
+}
 /**
  * @public
  */
@@ -2120,6 +2341,18 @@ export interface DescribeUserResponse {
      * @public
      */
     Office?: string;
+    /**
+     * <p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>
+     * @public
+     */
+    IdentityProviderUserId?: string;
+    /**
+     * <p>
+     *          Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.
+     *       </p>
+     * @public
+     */
+    IdentityProviderIdentityStoreId?: string;
 }
 /**
  * @public
@@ -2750,6 +2983,76 @@ export interface GetMobileDeviceAccessOverrideResponse {
      */
     DateModified?: Date;
 }
+/**
+ * @public
+ */
+export interface GetPersonalAccessTokenMetadataRequest {
+    /**
+     * <p>
+     *          The Organization ID. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+    /**
+     * <p>
+     *          The Personal Access Token ID.</p>
+     * @public
+     */
+    PersonalAccessTokenId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetPersonalAccessTokenMetadataResponse {
+    /**
+     * <p>
+     *          The Personal Access Token ID.</p>
+     * @public
+     */
+    PersonalAccessTokenId?: string;
+    /**
+     * <p>
+     *          The WorkMail User ID.
+     *       </p>
+     * @public
+     */
+    UserId?: string;
+    /**
+     * <p>
+     *          The Personal Access Token name.
+     *       </p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>
+     *          The date when the Personal Access Token ID was created.
+     *       </p>
+     * @public
+     */
+    DateCreated?: Date;
+    /**
+     * <p>
+     *          The date when the Personal Access Token ID was last used.
+     *       </p>
+     * @public
+     */
+    DateLastUsed?: Date;
+    /**
+     * <p>
+     *          The time when the Personal Access Token ID will expire.
+     *       </p>
+     * @public
+     */
+    ExpiresTime?: Date;
+    /**
+     * <p>
+     *          Lists all the Personal Access Token permissions for a mailbox.
+     *       </p>
+     * @public
+     */
+    Scopes?: string[];
+}
 /**
  * <p>The representation of an WorkMail group.</p>
  * @public
@@ -3697,6 +4000,112 @@ export interface ListOrganizationsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListPersonalAccessTokensRequest {
+    /**
+     * <p>
+     *          The Organization ID. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+    /**
+     * <p>
+     *          The WorkMail User ID.
+     *       </p>
+     * @public
+     */
+    UserId?: string;
+    /**
+     * <p>
+     *          The token from the previous response to query the next page.</p>
+     * @public
+     */
+    NextToken?: string;
+    /**
+     * <p>
+     *         The maximum amount of items that should be returned in a response.
+     *       </p>
+     * @public
+     */
+    MaxResults?: number;
+}
+/**
+ * <p>
+ *          The summary of the Personal Access Token.
+ *       </p>
+ * @public
+ */
+export interface PersonalAccessTokenSummary {
+    /**
+     * <p>
+     *          The ID of the Personal Access Token.
+     *          </p>
+     * @public
+     */
+    PersonalAccessTokenId?: string;
+    /**
+     * <p>
+     *          The user ID of the WorkMail user associated with the Personal Access Token.
+     *       </p>
+     * @public
+     */
+    UserId?: string;
+    /**
+     * <p>
+     *          The name of the Personal Access Token.
+     *       </p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>
+     *          The date when the Personal Access Token was created.
+     *       </p>
+     * @public
+     */
+    DateCreated?: Date;
+    /**
+     * <p>
+     *          The date when the Personal Access Token was last used.
+     *       </p>
+     * @public
+     */
+    DateLastUsed?: Date;
+    /**
+     * <p>
+     *          The date when the Personal Access Token will expire.
+     *       </p>
+     * @public
+     */
+    ExpiresTime?: Date;
+    /**
+     * <p>
+     *          Lists all the Personal Access Token permissions for a mailbox.
+     *       </p>
+     * @public
+     */
+    Scopes?: string[];
+}
+/**
+ * @public
+ */
+export interface ListPersonalAccessTokensResponse {
+    /**
+     * <p>
+     *          The token from the previous response to query the next page.</p>
+     * @public
+     */
+    NextToken?: string;
+    /**
+     * <p>
+     *          Lists all the personal tokens in an organization or user, if user ID is provided.
+     *       </p>
+     * @public
+     */
+    PersonalAccessTokenSummaries?: PersonalAccessTokenSummary[];
+}
 /**
  * @public
  */
@@ -3924,6 +4333,11 @@ export interface ListUsersFilters {
      * @public
      */
     State?: EntityState;
+    /**
+     * <p>Filters only users with the ID from the IAM Identity Center.</p>
+     * @public
+     */
+    IdentityProviderUserIdPrefix?: string;
 }
 /**
  * @public
@@ -3996,6 +4410,16 @@ export interface User {
      * @public
      */
     DisabledDate?: Date;
+    /**
+     * <p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>
+     * @public
+     */
+    IdentityProviderUserId?: string;
+    /**
+     * <p>Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>
+     * @public
+     */
+    IdentityProviderIdentityStoreId?: string;
 }
 /**
  * @public
@@ -4112,6 +4536,41 @@ export interface PutEmailMonitoringConfigurationRequest {
  */
 export interface PutEmailMonitoringConfigurationResponse {
 }
+/**
+ * @public
+ */
+export interface PutIdentityProviderConfigurationRequest {
+    /**
+     * <p>
+     *          The ID of the WorkMail Organization. </p>
+     * @public
+     */
+    OrganizationId: string | undefined;
+    /**
+     * <p>
+     *          The authentication mode used in WorkMail.</p>
+     * @public
+     */
+    AuthenticationMode: IdentityProviderAuthenticationMode | undefined;
+    /**
+     * <p>
+     *          The details of the IAM Identity Center configuration.</p>
+     * @public
+     */
+    IdentityCenterConfiguration: IdentityCenterConfiguration | undefined;
+    /**
+     * <p>
+     *          The details of the Personal Access Token configuration.
+     *       </p>
+     * @public
+     */
+    PersonalAccessTokenConfiguration: PersonalAccessTokenConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface PutIdentityProviderConfigurationResponse {
+}
 /**
  * @public
  */
@@ -4950,7 +5409,7 @@ export interface UpdateUserRequest {
      */
     Company?: string;
     /**
-     * <p>Updates the user's zipcode.</p>
+     * <p>Updates the user's zip code.</p>
      * @public
      */
     ZipCode?: string;
@@ -4969,6 +5428,11 @@ export interface UpdateUserRequest {
      * @public
      */
     Office?: string;
+    /**
+     * <p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p>
+     * @public
+     */
+    IdentityProviderUserId?: string;
 }
 /**
  * @public
@@ -4983,14 +5447,30 @@ export declare const EwsAvailabilityProviderFilterSensitiveLog: (obj: EwsAvailab
  * @internal
  */
 export declare const CreateAvailabilityConfigurationRequestFilterSensitiveLog: (obj: CreateAvailabilityConfigurationRequest) => any;
+/**
+ * @internal
+ */
+export declare const CreateResourceRequestFilterSensitiveLog: (obj: CreateResourceRequest) => any;
 /**
  * @internal
  */
 export declare const CreateUserRequestFilterSensitiveLog: (obj: CreateUserRequest) => any;
+/**
+ * @internal
+ */
+export declare const DescribeResourceResponseFilterSensitiveLog: (obj: DescribeResourceResponse) => any;
 /**
  * @internal
  */
 export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
+/**
+ * @internal
+ */
+export declare const ResourceFilterSensitiveLog: (obj: Resource) => any;
+/**
+ * @internal
+ */
+export declare const ListResourcesResponseFilterSensitiveLog: (obj: ListResourcesResponse) => any;
 /**
  * @internal
  */
@@ -5015,6 +5495,10 @@ export declare const TestAvailabilityConfigurationRequestFilterSensitiveLog: (ob
  * @internal
  */
 export declare const UpdateAvailabilityConfigurationRequestFilterSensitiveLog: (obj: UpdateAvailabilityConfigurationRequest) => any;
+/**
+ * @internal
+ */
+export declare const UpdateResourceRequestFilterSensitiveLog: (obj: UpdateResourceRequest) => any;
 /**
  * @internal
  */

package/dist-types/pagination/ListPersonalAccessTokensPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListPersonalAccessTokensCommandInput, ListPersonalAccessTokensCommandOutput } from "../commands/ListPersonalAccessTokensCommand";
+import { WorkMailPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListPersonalAccessTokens: (config: WorkMailPaginationConfiguration, input: ListPersonalAccessTokensCommandInput, ...rest: any[]) => Paginator<ListPersonalAccessTokensCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -10,6 +10,7 @@ export * from "./ListMailboxExportJobsPaginator";
 export * from "./ListMailboxPermissionsPaginator";
 export * from "./ListMobileDeviceAccessOverridesPaginator";
 export * from "./ListOrganizationsPaginator";
+export * from "./ListPersonalAccessTokensPaginator";
 export * from "./ListResourceDelegatesPaginator";
 export * from "./ListResourcesPaginator";
 export * from "./ListUsersPaginator";