WorkMail Exemples d'Amazon utilisant AWS CLI

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

La associate-delegate-to-resource commande 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 aucun résultat.

Pour ajouter un membre à un groupe

La associate-member-to-group commande 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 aucun résultat.

Pour créer un alias

La create-alias commande 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 aucun résultat.

Pour créer un nouveau groupe

La create-group commande 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 créer une nouvelle ressource

La create-resource commande 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 créer un nouvel utilisateur

La create-user commande 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 supprimer une règle de contrôle d'accès

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

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Travailler avec les règles de contrôle d'accès dans le manuel Amazon WorkMail Administrator Guide.

Pour supprimer un alias

La delete-alias commande suivante supprime l'alias de 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 aucun résultat.

Pour supprimer un groupe existant

La delete-group commande 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 aucun résultat.

Pour supprimer les autorisations de boîte aux lettres

La delete-mailbox-permissions commande 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 aucun résultat.

Pour supprimer une ressource existante

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

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

Cette commande ne produit aucun résultat.

Pour supprimer un utilisateur

La delete-user commande 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 aucun résultat.

Pour désactiver une entité existante

La deregister-from-work-mail commande 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 aucun résultat.

Pour récupérer des informations pour un groupe

La describe-group commande suivante permet de récupérer des 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 récupérer des informations pour une organisation

La describe-organization commande suivante permet de récupérer les informations relatives à l' WorkMail organisation Amazon 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 Working with Organizations dans le manuel Amazon WorkMail Administrator Guide.

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

La describe-resource commande suivante permet de récupérer des 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 récupérer les informations utilisateur

La describe-user commande suivante permet de récupérer des 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 supprimer un membre d'une ressource

La disassociate-delegate-from-resource commande 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 aucun résultat.

Pour supprimer un membre d'un groupe

La disassociate-member-from-group commande 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 aucun résultat.

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

L'get-access-control-effectexemple suivant montre l'effet des règles de contrôle d'accès de WorkMail l'organisation Amazon spécifiée pour l'adresse IP, l'action du 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 la section Travailler avec les règles de contrôle d'accès dans le manuel Amazon WorkMail Administrator Guide.

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

La get-mailbox-details commande suivante permet de récupérer des informations 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 la section Gestion des comptes utilisateurs dans le manuel Amazon WorkMail Administrator Guide.

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

L'list-access-control-rulesexemple suivant répertorie les règles de contrôle d'accès pour l' WorkMail organisation Amazon 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 la section Travailler avec les règles de contrôle d'accès dans le manuel Amazon WorkMail Administrator Guide.

Pour répertorier les alias d'un membre

La list-aliases commande suivante répertorie les alias du 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 répertorier les membres du groupe

La list-group-members commande 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 récupérer une liste de groupes

La list-groups commande suivante permet de récupérer les résumés 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 récupérer les autorisations de boîte aux lettres

La list-mailbox-permissions commande suivante récupère les autorisations de 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 récupérer une liste d'organisations

La list-organizations commande suivante permet de récupérer des résumés des organisations du client.

aws workmail list-organizations

Sortie :

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

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

La list-resource-delegates commande suivante permet de récupérer 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 récupérer une liste de ressources

La list-resources commande suivante permet de récupérer des résumés des ressources pour 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 répertorier les balises d'une ressource

L'list-tags-for-resourceexemple suivant répertorie les balises pour l' WorkMail organisation Amazon 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 la section Marquage d'une organisation dans le manuel Amazon WorkMail Administrator Guide.

Pour récupérer une liste d'utilisateurs

La list-users commande suivante permet de récupérer les résumés 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 mettre une nouvelle règle de contrôle d'accès

L'put-access-control-ruleexemple suivant refuse à l'utilisateur spécifié l'accès à l' WorkMail organisation Amazon 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 aucun résultat.

Pour plus d'informations, consultez la section Travailler avec les règles de contrôle d'accès dans le manuel Amazon WorkMail Administrator Guide.

Pour définir les autorisations de boîte aux lettres

La put-mailbox-permissions commande suivante définit les autorisations d'accès complètes pour le bénéficiaire spécifié (utilisateur ou groupe). 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 aucun résultat.

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

La register-to-work-mail commande 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 aucun résultat.

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

La reset-password commande 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 aucun résultat.

Pour appliquer un tag à une ressource

L'tag-resourceexemple suivant applique une balise avec la clé « priority » et la valeur « 1 » à l' WorkMail organisation Amazon 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 aucun résultat.

Pour plus d'informations, consultez la section Marquage d'une organisation dans le manuel Amazon WorkMail Administrator Guide.

Pour annuler le balisage d'une ressource

L'untag-resourceexemple suivant supprime le tag spécifié de l' WorkMail organisation Amazon 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 aucun résultat.

Pour plus d'informations, consultez la section Marquage d'une organisation dans le manuel Amazon WorkMail Administrator Guide.

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

La update-mailbox-quota commande 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 aucun résultat.

Pour plus d'informations, consultez la section Gestion des comptes utilisateurs dans le manuel Amazon WorkMail Administrator Guide.

Pour mettre à jour une adresse e-mail principale

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

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 aucun résultat.

Pour mettre à jour une ressource

La update-resource commande 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 aucun résultat.