WorkMail Esempi di utilizzo di Amazon AWS CLI - AWS Command Line Interface
Azioni

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

WorkMail Esempi di utilizzo di Amazon AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando il AWS Command Line Interface con Amazon WorkMail.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come usareassociate-delegate-to-resource.

AWS CLI

Come aggiungere un delegato a una risorsa

Il comando associate-delegate-to-resource seguente aggiunge un delegato a una risorsa.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzareassociate-member-to-group.

AWS CLI

Come aggiungere un membro a un gruppo

Il comando associate-member-to-group seguente aggiunge il membro specificato a un gruppo.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzarecreate-alias.

AWS CLI

Come creare un alias

Il comando create-alias seguente crea un alias per l’entità specificata (utente o gruppo).

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzarecreate-group.

AWS CLI

Come creare un nuovo gruppo

Il comando create-group seguente crea un nuovo gruppo per l’organizzazione specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarecreate-resource.

AWS CLI

Come creare una nuova risorsa

Il comando create-resource seguente crea una nuova risorsa (sala riunioni) per l’organizzazione specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarecreate-user.

AWS CLI

Come creare un nuovo utente

Il comando create-user seguente crea un nuovo utente.

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

Output:

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

Il seguente esempio di codice mostra come utilizzaredelete-access-control-rule.

AWS CLI

Come eliminare una regola di controllo degli accessi

L'delete-access-control-ruleesempio seguente elimina la regola di controllo degli accessi specificata dall' WorkMail organizzazione Amazon specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Working with Access Control Rules nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzaredelete-alias.

AWS CLI

Come eliminare un alias

Il comando delete-alias seguente elimina l’alias per l’entità specificata (utente o gruppo).

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredelete-group.

AWS CLI

Come eliminare un gruppo esistente

Il delete-group comando seguente elimina un gruppo esistente da Amazon WorkMail.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredelete-mailbox-permissions.

AWS CLI

Come eliminare le autorizzazioni per la casella di posta

Il comando delete-mailbox-permissions seguente elimina le autorizzazioni per la casella di posta precedentemente concesse a un utente o a un gruppo. L’entità rappresenta l’utente proprietario della casella di posta e il beneficiario rappresenta l’utente o il gruppo per il quale eliminare le autorizzazioni.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredelete-resource.

AWS CLI

Come eliminare una risorsa esistente

Il delete-resource comando seguente elimina una risorsa esistente da Amazon WorkMail.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredelete-user.

AWS CLI

Come eliminare un utente

Il delete-user comando seguente elimina l'utente specificato da Amazon WorkMail e da tutti i sistemi successivi.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzarederegister-from-work-mail.

AWS CLI

Come disabilitare un’entità esistente

Il deregister-from-work-mail comando seguente impedisce a un'entità esistente (utente, gruppo o risorsa) di utilizzare Amazon WorkMail.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredescribe-group.

AWS CLI

Come recuperare informazioni per un gruppo

Il comando describe-group seguente restituisce le informazioni relative al gruppo specificato.

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

Output:

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

Il seguente esempio di codice mostra come utilizzaredescribe-organization.

AWS CLI

Come recuperare informazioni per un’organizzazione

Il describe-organization comando seguente recupera le informazioni per l' WorkMail organizzazione Amazon specificata.

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

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Working with Organizations nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-resource.

AWS CLI

Come recuperare informazioni per una risorsa

Il comando describe-resource seguente restituisce le informazioni relative alla risorsa specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzaredescribe-user.

AWS CLI

Come recuperare informazioni sull’utente

Il comando describe-user seguente restituisce le informazioni relative all’utente specificato.

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

Output:

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

Il seguente esempio di codice mostra come utilizzaredisassociate-delegate-from-resource.

AWS CLI

Come rimuovere un membro da una risorsa

Il comando disassociate-delegate-from-resource seguente rimuove il membro specificato da una risorsa.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaredisassociate-member-from-group.

AWS CLI

Come rimuovere un membro da un gruppo

Il comando disassociate-member-from-group seguente rimuove il membro specificato da un gruppo.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzareget-access-control-effect.

AWS CLI

Come ottenere l’effetto delle regole di controllo degli accessi

L'get-access-control-effectesempio seguente recupera l'effetto delle regole di controllo degli accessi WorkMail dell'organizzazione Amazon specificata per l'indirizzo IP, l'azione del protocollo di accesso e l'ID utente specificati.

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"

Output:

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

Per ulteriori informazioni, consulta Working with Access Control Rules nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzareget-mailbox-details.

AWS CLI

Come ottenere i dettagli sulla casella di posta di un utente

Il comando get-mailbox-details seguente recupera i dettagli sulla casella di posta dell’utente specificato.

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

Output:

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

Per ulteriori informazioni, consulta Managing User Accounts nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzarelist-access-control-rules.

AWS CLI

Come elencare le regole di controllo degli accessi

L'list-access-control-rulesesempio seguente elenca le regole di controllo degli accessi per l' WorkMail organizzazione Amazon specificata.

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

Output:

{
    "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
        }
    ]
}

Per ulteriori informazioni, consulta Working with Access Control Rules nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzarelist-aliases.

AWS CLI

Come elencare gli alias di un membro

Il comando list-aliases seguente elenca gli alias per il membro specificato (utente o gruppo).

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

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-group-members.

AWS CLI

Come elencare i membri del gruppo

Il comando list-group-members seguente elenca i membri del gruppo specificato.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-groups.

AWS CLI

Come recuperare un elenco di gruppi

Il comando list-groups seguente recupera i riepiloghi dei gruppi nell’organizzazione specificata.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come utilizzarelist-mailbox-permissions.

AWS CLI

Come recuperare le autorizzazioni per la casella di posta

Il comando list-mailbox-permissions seguente recupera le autorizzazioni per la casella di posta associate alla casella di posta dell’entità specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-organizations.

AWS CLI

Come recuperare un elenco di organizzazioni

Il comando list-organizations seguente recupera i riepiloghi delle organizzazioni del cliente.

aws workmail list-organizations

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-resource-delegates.

AWS CLI

Come elencare i delegati di una risorsa

Il comando list-resource-delegates seguente recupera l’elenco dei tag associati alla risorsa specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-resources.

AWS CLI

Come recuperare un elenco di risorse

Il comando list-resources seguente recupera i riepiloghi delle risorse per l’organizzazione specificata.

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

Output:

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

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come elencare i tag per una risorsa

L'list-tags-for-resourceesempio seguente elenca i tag per l' WorkMail organizzazione Amazon specificata.

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

Output:

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

Per ulteriori informazioni, consulta Tagging an Organization nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzarelist-users.

AWS CLI

Come recuperare un elenco di utenti

Il comando list-users seguente recupera i riepiloghi degli utenti nell’organizzazione specificata.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come utilizzareput-access-control-rule.

AWS CLI

Come inserire una nuova regola di controllo degli accessi

L'put-access-control-ruleesempio seguente nega all'utente specificato l'accesso all' WorkMail organizzazione Amazon specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Working with Access Control Rules nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzareput-mailbox-permissions.

AWS CLI

Come modificare le autorizzazioni per la casella di posta

Il comando put-mailbox-permissions seguente imposta le autorizzazioni di accesso complete per il beneficiario specificato (utente o gruppo). L’entità rappresenta il proprietario della casella di posta.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzareregister-to-work-mail.

AWS CLI

Come registrare un’entità esistente o disabilitata

Il register-to-work-mail comando seguente consente all'entità esistente specificata (utente, gruppo o risorsa) di utilizzare 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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzarereset-password.

AWS CLI

Come reimpostare una password utente

Il comando reset-password seguente reimposta la password per l’utente specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Come aggiungere un tag a una risorsa

L'tag-resourceesempio seguente applica un tag con chiave «priority» e valore «1" all' WorkMail organizzazione Amazon specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging an Organization nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Come rimuovere un tag da una risorsa

L'untag-resourceesempio seguente rimuove il tag specificato dall' WorkMail organizzazione Amazon specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging an Organization nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzareupdate-mailbox-quota.

AWS CLI

Come aggiornare la quota della casella di posta di un utente

Il comando update-mailbox-quota seguente modifica la quota della casella di posta dell’utente specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Managing User Accounts nella Amazon WorkMail Administrator Guide.

Il seguente esempio di codice mostra come utilizzareupdate-primary-email-address.

AWS CLI

Come aggiornare un indirizzo e-mail principale

Il comando update-primary-email-address seguente aggiorna l’indirizzo e-mail principale dell’entità specificata (utente, gruppo o risorsa).

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzareupdate-resource.

AWS CLI

Come aggiornare una risorsa

Il comando update-resource seguente aggiorna il nome della risorsa specificata.

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

Questo comando non produce alcun output.