Exemples d’utilisation de l’AWS CLI avec Amazon WorkMail

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Amazon WorkMail.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

Actions

L’exemple de code suivant montre comment utiliser associate-delegate-to-resource.

AWS CLI

Pour ajouter un délégué à une ressource

La commande associate-delegate-to-resource suivante ajoute un délégué à une ressource.


aws workmail associate-delegate-to-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez AssociateDelegateToResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser associate-member-to-group.

AWS CLI

Pour ajouter un membre à un groupe

La commande associate-member-to-group suivante ajoute le membre spécifié à un groupe.


aws workmail associate-member-to-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --member-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez AssociateMemberToGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-alias.

AWS CLI

Pour créer un alias

La commande create-alias suivante crée un alias pour l’entité spécifiée (utilisateur ou groupe).


aws workmail create-alias \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --alias exampleAlias@site.awsapps.com

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez CreateAlias dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-group.

AWS CLI

Pour créer un nouveau groupe

La commande create-group suivante crée un nouveau groupe pour l’organisation spécifiée.


aws workmail create-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --name exampleGroup1

Sortie :


{
    "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444"
}

Pour plus de détails sur l’API, consultez CreateGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-resource.

AWS CLI

Pour créer une nouvelle ressource

La commande create-resource suivante crée une nouvelle ressource (salle de réunion) pour l’organisation spécifiée.


aws workmail create-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --name exampleRoom1 \
    --type ROOM

Sortie :


{
    "ResourceId": "r-7afe0efbade843a58cdc10251fce992c"
}

Pour plus de détails sur l’API, consultez CreateResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-user.

AWS CLI

Pour créer un nouvel utilisateur

La commande create-user suivante crée un nouvel utilisateur.


aws workmail create-user \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --name exampleName \
    --display-name exampleDisplayName \
    --password examplePa$$w0rd

Sortie :


{
    "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333"
}

Pour plus de détails sur l’API, consultez CreateUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-access-control-rule.

AWS CLI

Pour supprimer une règle de contrôle d’accès

L’exemple delete-access-control-rule suivant supprime la règle de contrôle d’accès spécifiée de l’organisation Amazon WorkMail spécifiée.


aws workmail delete-access-control-rule \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza \
    --name "myRule"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des règles de contrôle d’accès dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez DeleteAccessControlRule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-alias.

AWS CLI

Pour supprimer un alias

La commande delete-alias suivante supprime l’alias pour l’entité spécifiée (utilisateur ou groupe).


aws workmail delete-alias \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --alias exampleAlias@site.awsapps.com

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeleteAlias dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-group.

AWS CLI

Pour supprimer un groupe existant

La commande delete-group suivante supprime un groupe existant d’Amazon WorkMail.


aws workmail delete-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeleteGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-mailbox-permissions.

AWS CLI

Pour supprimer les autorisations de boîte aux lettres

La commande delete-mailbox-permissions suivante supprime les autorisations de boîte aux lettres précédemment accordées à un utilisateur ou à un groupe. L’entité représente l’utilisateur propriétaire de la boîte aux lettres et le bénéficiaire représente l’utilisateur ou le groupe pour lequel les autorisations doivent être supprimées.


aws workmail delete-mailbox-permissions \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --grantee-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeleteMailboxPermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-resource.

AWS CLI

Pour supprimer une ressource existante

La commande delete-resource suivante supprime une ressource existante d’Amazon WorkMail.


aws workmail delete-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeleteResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-user.

AWS CLI

Pour supprimer un utilisateur

La commande delete-user suivante supprime l’utilisateur spécifié d’Amazon WorkMail et de tous les systèmes suivants.


aws workmail delete-user \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeleteUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser deregister-from-work-mail.

AWS CLI

Pour désactiver une entité existante

La commande deregister-from-work-mail suivante empêche une entité existante (utilisateur, groupe ou ressource) d’utiliser Amazon WorkMail.


aws workmail deregister-from-work-mail \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DeregisterFromWorkMail dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-group.

AWS CLI

Pour récupérer les informations relatives à un groupe

La commande describe-group suivante extrait les informations sur le groupe spécifié.


aws workmail describe-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

Sortie :


{
    "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
    "Name": "exampleGroup1",
    "State": "ENABLED"
}

Pour plus de détails sur l’API, consultez DescribeGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-organization.

AWS CLI

Pour récupérer les informations d’une organisation

La commande describe-organization suivante extrait les informations de l’organisation Amazon WorkMail spécifiée.


aws workmail describe-organization \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

Sortie :


{
    "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
    "Alias": "alias",
    "State": "Active",
    "DirectoryId": "d-926726012c",
    "DirectoryType": "VpcDirectory",
    "DefaultMailDomain": "site.awsapps.com",
    "CompletedDate": 1522693605.468,
    "ARN": "arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza"
}

Pour plus d’informations, consultez Utilisation des organisations dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez DescribeOrganization dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-resource.

AWS CLI

Pour récupérer les informations relatives à une ressource

La commande describe-resource suivante extrait les informations sur la ressource spécifiée.


aws workmail describe-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c

Sortie :


{
    "ResourceId": "r-7afe0efbade843a58cdc10251fce992c",
    "Name": "exampleRoom1",
    "Type": "ROOM",
    "BookingOptions": {
        "AutoAcceptRequests": true,
        "AutoDeclineRecurringRequests": false,
        "AutoDeclineConflictingRequests": true
    },
    "State": "ENABLED"
}

Pour plus de détails sur l’API, consultez DescribeResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-user.

AWS CLI

Pour récupérer les informations utilisateur

La commande describe-user suivante extrait les informations sur l’utilisateur spécifié.


aws workmail describe-user \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

Sortie :


{
    "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333",
    "Name": "exampleUser1",
    "Email": "exampleUser1@site.awsapps.com",
    "DisplayName": "",
    "State": "ENABLED",
    "UserRole": "USER",
    "EnabledDate": 1532459261.827
}

Pour plus de détails sur l’API, consultez DescribeUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disassociate-delegate-from-resource.

AWS CLI

Pour supprimer un membre d’une ressource

La commande disassociate-delegate-from-resource suivante supprime le membre spécifié d’une ressource.


ws workmail disassociate-delegate-from-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DisassociateDelegateFromResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disassociate-member-from-group.

AWS CLI

Pour supprimer un membre d’un groupe

La commande disassociate-member-from-group suivante supprime le membre spécifié d’un groupe.


aws workmail disassociate-member-from-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --member-id S-1-1-11-1111111111-2222222222-3333333333-3333

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez DisassociateMemberFromGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-access-control-effect.

AWS CLI

Pour obtenir l’effet des règles de contrôle d’accès

L’exemple get-access-control-effect suivant récupère l’effet des règles de contrôle d’accès de l’organisation Amazon WorkMail spécifiée pour l’adresse IP, l’action de protocole d’accès et l’ID utilisateur spécifiés.


aws workmail get-access-control-effect \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza \
    --ip-address "192.0.2.0" \
    --action "WindowsOutlook" \
    --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333"

Sortie :


{
    "Effect": "DENY",
    "MatchedRules": [
        "myRule"
    ]
}

Pour plus d’informations, consultez Utilisation des règles de contrôle d’accès dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez GetAccessControlEffect dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-mailbox-details.

AWS CLI

Pour obtenir les détails de la boîte aux lettres d’un utilisateur

La commande get-mailbox-details suivante extrait des détails sur la boîte aux lettres de l’utilisateur spécifié.


aws workmail get-mailbox-details \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

Sortie :


{
    "MailboxQuota": 51200,
    "MailboxSize": 0.03890800476074219
}

Pour plus d’informations, consultez Gestion des comptes d’utilisateur dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez GetMailboxDetails dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-access-control-rules.

AWS CLI

Pour répertorier les règles de contrôle d’accès

L’exemple list-access-control-rules suivant répertorie les règles de contrôle d’accès pour l’organisation Amazon WorkMail spécifiée.


aws workmail list-access-control-rules \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza

Sortie :


{
    "Rules": [
        {
            "Name": "default",
            "Effect": "ALLOW",
            "Description": "Default WorkMail Rule",
            "DateCreated": 0.0,
            "DateModified": 0.0
        },
        {
            "Name": "myRule",
            "Effect": "DENY",
            "Description": "my rule",
            "UserIds": [
            "S-1-1-11-1111111111-2222222222-3333333333-3333"
            ],
            "DateCreated": 1581635628.0,
            "DateModified": 1581635628.0
        }
    ]
}

Pour plus d’informations, consultez Utilisation des règles de contrôle d’accès dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez ListAccessControlRules dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-aliases.

AWS CLI

Pour répertorier les alias d’un membre

La commande list-aliases suivante répertorie les alias pour le membre spécifié (utilisateur ou groupe).


aws workmail list-aliases \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

Sortie :


{
    "Aliases": [
        "exampleAlias@site.awsapps.com",
        "exampleAlias1@site.awsapps.com"
    ]
}

Pour plus de détails sur l’API, consultez ListAliases dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-group-members.

AWS CLI

Pour répertorier les membres d’un groupe

La commande list-group-members suivante répertorie les membres du groupe spécifié.


aws workmail list-group-members \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

Sortie :


{
    "Members": [
        {
            "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
            "Name": "exampleUser1",
            "Type": "USER",
            "State": "ENABLED",
            "EnabledDate": 1532459261.827
        }
    ]
}

Pour plus de détails sur l’API, consultez ListGroupMembers dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-groups.

AWS CLI

Pour récupérer une liste de groupes

La commande list-groups suivante extrait les récapitulatifs des groupes de l’organisation spécifiée.


aws workmail list-groups \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

Sortie :


{
    "Groups": [
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444",
            "Name": "exampleGroup1",
            "State": "DISABLED"
        },
        {
            "Id": "S-4-4-44-1122222222-2222233333-3333334444-4444",
            "Name": "exampleGroup2",
            "State": "ENABLED"
        }
    ]
}

Pour plus de détails sur l’API, consultez ListGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-mailbox-permissions.

AWS CLI

Pour récupérer les autorisations d’accès à une boîte aux lettres

La commande list-mailbox-permissions suivante extrait les autorisations d’accès à une boîte aux lettres associées à la boîte aux lettres de l’entité spécifiée.


aws workmail list-mailbox-permissions \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

Sortie :


{
    "Permissions": [
        {
            "GranteeId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
            "GranteeType": "USER",
            "PermissionValues": [
                "FULL_ACCESS"
            ]
        }
    ]
}

Pour plus de détails sur l’API, consultez ListMailboxPermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-organizations.

AWS CLI

Pour récupérer une liste des organisations

La commande list-organizations suivante extrait les récapitulatifs des organisations du client.


aws workmail list-organizations

Sortie :


{
    "OrganizationSummaries": [
        {
            "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
            "Alias": "exampleAlias",
            "State": "Active"
        }
    ]
}

Pour plus de détails sur l’API, consultez ListOrganizations dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-resource-delegates.

AWS CLI

Pour répertorier les délégués d’une ressource

La commande list-resource-delegates suivante permet d’extraire les délégués associés à la ressource spécifiée.


aws workmail list-resource-delegates \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-68bf2d3b1c0244aab7264c24b9217443

Sortie :


{
    "Delegates": [
        {
            "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
            "Type": "USER"
        }
    ]
}

Pour plus de détails sur l’API, consultez ListResourceDelegates dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-resources.

AWS CLI

Pour récupérer une liste de ressources

La commande list-resources suivante extrait les récapitulatifs des ressources de l’organisation spécifiée.


aws workmail list-resources \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

Sortie :


{
    "Resources": [
        {
            "Id": "r-7afe0efbade843a58cdc10251fce992c",
            "Name": "exampleRoom1",
            "Type": "ROOM",
            "State": "ENABLED"
        }
    ]
}

Pour plus de détails sur l’API, consultez ListResources dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises d’une ressource

L’exemple list-tags-for-resource suivant répertorie les balises de l’organisation Amazon WorkMail spécifiée.


aws workmail list-tags-for-resource \
    --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza

Sortie :


{
    "Tags": [
        {
            "Key": "priority",
            "Value": "1"
        }
    ]
}

Pour plus d’informations, consultez Balisage d’une organisation dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-users.

AWS CLI

Pour récupérer une liste des utilisateurs

La commande list-users suivante extrait les récapitulatifs des utilisateurs de l’organisation spécifiée.


aws workmail list-users \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

Sortie :


{
    "Users": [
        {
            "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
            "Email": "exampleUser1@site.awsapps.com",
            "Name": "exampleUser1",
            "State": "ENABLED",
            "UserRole": "USER",
            "EnabledDate": 1532459261.827
        },
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444",
            "Name": "exampleGuestUser",
            "State": "DISABLED",
            "UserRole": "SYSTEM_USER"
        }
    ]
}

Pour plus de détails sur l’API, consultez ListUsers dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-access-control-rule.

AWS CLI

Pour créer une règle de contrôle d’accès

L’exemple put-access-control-rule suivant refuse à l’utilisateur spécifié l’accès à l’organisation Amazon WorkMail spécifiée.


aws workmail put-access-control-rule \
    --name "myRule" \
    --effect "DENY" \
    --description "my rule" \
    --user-ids "S-1-1-11-1111111111-2222222222-3333333333-3333" \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des règles de contrôle d’accès dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez PutAccessControlRule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-mailbox-permissions.

AWS CLI

Pour modifier les autorisations d’accès à une boîte aux lettres

La commande put-mailbox-permissions suivante définit les autorisations d’accès complètes pour le bénéficiaire (utilisateur ou groupe) spécifié. L’entité représente le propriétaire de la boîte aux lettres.


aws workmail put-mailbox-permissions \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --grantee-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --permission-values FULL_ACCESS

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez PutMailboxPermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser register-to-work-mail.

AWS CLI

Pour enregistrer une entité existante ou désactivée

La commande register-to-work-mail suivante permet à l’entité existante spécifiée (utilisateur, groupe ou ressource) d’utiliser Amazon WorkMail.


aws workmail register-to-work-mail \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --email exampleGroup1@site.awsapps.com

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez RegisterToWorkMail dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reset-password.

AWS CLI

Pour réinitialiser le mot de passe d’un utilisateur

La commande reset-password suivante réinitialise le mot de passe de l’utilisateur spécifié.


aws workmail reset-password \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --password examplePa$$w0rd

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez ResetPassword dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour appliquer une balise à une ressource

L’exemple tag-resource suivant applique une balise avec la clé « priority » et la valeur « 1 » à l’organisation Amazon WorkMail spécifiée.


aws workmail tag-resource \
    --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
    --tags "Key=priority,Value=1"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage d’une organisation dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez TagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer une balise d’une ressource

L’exemple untag-resource suivant supprime la balise spécifiée de l’organisation Amazon WorkMail spécifiée.


aws workmail untag-resource \
    --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
    --tag-keys "priority"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage d’une organisation dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-mailbox-quota.

AWS CLI

Pour mettre à jour le quota de boîte aux lettres d’un utilisateur

La commande update-mailbox-quota suivante modifie le quota de boîte aux lettres de l’utilisateur spécifié.


aws workmail update-mailbox-quota \
    --organization-id m-n1pq2345678r901st2u3vx45x6789yza \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --mailbox-quota 40000

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des comptes d’utilisateur dans le Guide de l’administrateur Amazon WorkMail.

Pour plus de détails sur l’API, consultez UpdateMailboxQuota dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-primary-email-address.

AWS CLI

Pour mettre à jour une adresse e-mail principale

La commande update-primary-email-address suivante met à jour l’adresse e-mail principale de l’entité (utilisateur, groupe ou ressource) spécifiée.


aws workmail update-primary-email-address \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --email exampleUser2@site.awsapps.com

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez UpdatePrimaryEmailAddress dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-resource.

AWS CLI

Pour mettre à jour une ressource

La commande update-resource suivante met à jour le nom de la ressource spécifiée.


aws workmail update-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c \
    --name exampleRoom2

Cette commande ne produit aucune sortie.

Pour plus de détails sur l’API, consultez UpdateResource dans la Référence des commandes de l’AWS CLI.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

WorkDocs

Flux de message Amazon WorkMail