Exemples d’utilisation de l’AWS CLI avec Amazon Chime - AWS Command Line Interface
Actions

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

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 Chime.

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

L’exemple de code suivant montre comment utiliser associate-phone-number-with-user.

AWS CLI

Pour associer un numéro de téléphone à un utilisateur

L’exemple associate-phone-number-with-user suivant associe le numéro de téléphone spécifié à un utilisateur.

aws chime associate-phone-number-with-user \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --e164-phone-number "+12065550100"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des numéros de téléphone de l’utilisateur dans le Guide de l’administrateur Amazon Chime.

L’exemple de code suivant montre comment utiliser associate-signin-delegate-groups-with-account.

AWS CLI

Pour associer des groupes de délégués de connexion

L’exemple associate-signin-delegate-groups-with-account suivant associe le groupe de délégués de connexion spécifié au compte Amazon Chime spécifié.

aws chime associate-signin-delegate-groups-with-account \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --signin-delegate-groups GroupName=my_users

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des accès et des autorisations utilisateur dans le Guide de l’administrateur Amazon Chime.

L’exemple de code suivant montre comment utiliser batch-create-room-membership.

AWS CLI

Pour créer plusieurs adhésions à une salle de conversation

L’exemple batch-create-room-membership suivant ajoute plusieurs utilisateurs à une salle de conversation en tant que membres. Il attribue également des rôles d’administrateur et de membre aux utilisateurs.

aws chime batch-create-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member"

Sortie :

{
    "ResponseMetadata": {
        "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb",
        "HTTPStatusCode": 201,
        "HTTPHeaders": {
            "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb",
            "content-type": "application/json",
            "content-length": "13",
            "date": "Mon, 02 Dec 2019 22:46:58 GMT",
            "connection": "keep-alive"
        },
        "RetryAttempts": 0
    },
    "Errors": []
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

L’exemple de code suivant montre comment utiliser batch-delete-phone-number.

AWS CLI

Pour supprimer plusieurs numéros de téléphone

L’exemple batch-delete-phone-number suivant supprime tous les numéros de téléphone spécifiés.

aws chime batch-delete-phone-number \
    --phone-number-ids "%2B12065550100" "%2B12065550101"

Cette commande ne produit aucune sortie. Sortie :

{
    "PhoneNumberErrors": []
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour suspendre plusieurs utilisateurs

L’exemple batch-suspend-user suivant suspend les utilisateurs répertoriés du compte Amazon Chime spécifié.

aws chime batch-suspend-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

Sortie :

{
    "UserErrors": []
}

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

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

AWS CLI

Pour annuler la suspension de plusieurs utilisateurs

L’exemple batch-unsuspend-user suivant supprime toute suspension antérieure pour les utilisateurs répertoriés sur le compte Amazon Chime spécifié.

aws chime batch-unsuspend-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

Sortie :

{
    "UserErrors": []
}

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

L’exemple de code suivant montre comment utiliser batch-update-phone-number.

AWS CLI

Pour mettre à jour plusieurs types de produits de numéros de téléphone en même temps

L’exemple batch-update-phone-number suivant met à jour les types de produits pour tous les numéros de téléphone spécifiés.

aws chime batch-update-phone-number \
    --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling

Sortie :

{
    "PhoneNumberErrors": []
}

Pour mettre à jour les noms d’appel de plusieurs numéros de téléphone en même temps

L’exemple batch-update-phone-number suivant met à jour les noms d’appel de tous les numéros de téléphone spécifiés.

aws chime batch-update-phone-number \
    --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2

Sortie :

{
    "PhoneNumberErrors": []
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour plusieurs utilisateurs en une seule commande

L’exemple batch-update-user suivant met à jour LicenseType pour chacun des utilisateurs répertoriés dans le compte Amazon Chime spécifié.

aws chime batch-update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
    --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic"

Sortie :

{
    "UserErrors": []
}

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

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

AWS CLI

Pour créer un compte

L’exemple create-account suivant crée un compte Amazon Chime sous le compte AWS de l’administrateur.

aws chime create-account \
    --name MyChimeAccount

Sortie :

{
    "Account": {
        "AwsAccountId": "111122223333",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "Name": "MyChimeAccount",
        "AccountType": "Team",
        "CreatedTimestamp": "2019-01-04T17:11:22.003Z",
        "DefaultLicense": "Pro",
        "SupportedLicenses": [
            "Basic",
            "Pro"
        ],
        "SigninDelegateGroups": [
            {
                "GroupName": "myGroup"
            },
        ]
    }
}

Pour plus d’informations, consultez Démarrage dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour créer un bot Amazon Chime

L’exemple create-bot suivant crée un bot pour le compte Amazon Chime Enterprise spécifié.

aws chime create-bot \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --display-name "myBot" \
    --domain "example.com"

Sortie :

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": false,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
}

Pour plus d’informations, consultez Intégration d’un chatbot avec Amazon Chime dans le Manuel du développeur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser create-phone-number-order.

AWS CLI

Pour créer un ordre de numéros de téléphone

L’exemple create-phone-number-order suivant crée un ordre pour les numéros de téléphone spécifiés.

aws chime create-phone-number-order \
    --product-type VoiceConnector \
    --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102"

Sortie :

{
    "PhoneNumberOrder": {
        "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012",
        "ProductType": "VoiceConnector",
        "Status": "Processing",
        "OrderedPhoneNumbers": [
            {
                "E164PhoneNumber": "+12065550100",
                "Status": "Processing"
            },
            {
               "E164PhoneNumber": "+12065550101",
               "Status": "Processing"
            },
            {
              "E164PhoneNumber": "+12065550102",
              "Status": "Processing"
            }
        ],
        "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
        "UpdatedTimestamp": "2019-08-09T21:35:22.408Z"
    }
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour créer une adhésion à une salle de conversation

L’exemple create-room-membership suivant ajoute l’utilisateur spécifié à la salle de conversation en tant que membre.

aws chime create-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Sortie :

{
    "RoomMembership": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Member": {
            "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k",
            "MemberType": "User",
            "Email": "janed@example.com",
            "FullName": "Jane Doe",
            "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
        },
        "Role": "Member",
        "InvitedBy": "arn:aws:iam::111122223333:user/alejandro",
        "UpdatedTimestamp": "2019-12-02T22:36:41.969Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour créer une salle de conversation

L’exemple create-room suivant crée une salle de conversation pour le compte Amazon Chime spécifié.

aws chime create-room \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --name chatRoom

Sortie :

{
    "Room": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Name": "chatRoom",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "CreatedBy": "arn:aws:iam::111122223333:user/alejandro",
        "CreatedTimestamp": "2019-12-02T22:29:31.549Z",
        "UpdatedTimestamp": "2019-12-02T22:29:31.549Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

  • Pour plus de détails sur l’API, consultez CreateRoom 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 profil utilisateur pour un appareil partagé

L’exemple create-user suivant crée un profil d’appareil partagé pour l’adresse e-mail spécifiée.

aws chime create-user \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --email roomdevice@example.com \
    --user-type SharedDevice

Sortie :

{
    "User": {
        "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "PrimaryEmail": "roomdevice@example.com",
        "DisplayName": "Room Device",
        "LicenseType": "Pro",
        "UserType": "SharedDevice",
        "UserRegistrationStatus": "Registered",
        "RegisteredOn": "2020-01-15T22:38:09.806Z",
        "AlexaForBusinessMetadata": {
            "IsAlexaForBusinessEnabled": false
        }
    }
}

Pour plus d’informations, consultez Préparation de la configuration dans le Guide de l’administrateur Amazon Chime.

  • 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-account.

AWS CLI

Pour supprimer un compte

L’exemple delete-account suivant supprime le compte spécifié.

aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression de votre compte dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour supprimer un numéro de téléphone

L’exemple delete-phone-number suivant place le numéro de téléphone spécifié dans la file d’attente de suppression.

aws chime delete-phone-number \
    --phone-number-id "+12065550100"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour supprimer un utilisateur en tant que membre d’une salle de conversation

L’exemple delete-room-membership suivant supprime le membre spécifié de la salle de conversation spécifiée.

aws chime delete-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour supprimer une salle de conversation

L’exemple delete-room suivant supprime la salle de conversation spécifiée, ainsi que les adhésions associées.

aws chime delete-room \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser disassociate-phone-number-from-user.

AWS CLI

Pour dissocier un numéro de téléphone d’un utilisateur

L’exemple disassociate-phone-number-from-user suivant dissocie un numéro de téléphone de l’utilisateur spécifié.

aws chime disassociate-phone-number-from-user \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des numéros de téléphone de l’utilisateur dans le Guide de l’administrateur Amazon Chime.

L’exemple de code suivant montre comment utiliser disassociate-signin-delegate-groups-from-account.

AWS CLI

Pour dissocier des groupes de délégués de connexion

L’exemple disassociate-signin-delegate-groups-from-account suivant dissocie le groupe de délégués de connexion spécifié du compte Amazon Chime spécifié.

aws chime disassociate-signin-delegate-groups-from-account \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --group-names "my_users"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des accès et des autorisations utilisateur dans le Guide de l’administrateur Amazon Chime.

L’exemple de code suivant montre comment utiliser get-account-settings.

AWS CLI

Pour récupérer les paramètres d’un compte

L’exemple get-account-settings suivant récupère les paramètres du compte spécifié.

aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Sortie :

{
    "AccountSettings": {
        "DisableRemoteControl": false,
        "EnableDialOut": false
    }
}

Pour plus d’informations, consultez Managing Your Amazon Chime Accounts dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour récupérer les informations d’un compte

L’exemple get-account suivant récupère les informations du compte Amazon Chime spécifié.

aws chime get-account \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Sortie :

{
    "Account": {
        "AwsAccountId": "111122223333",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "Name": "EnterpriseDirectory",
        "AccountType": "EnterpriseDirectory",
        "CreatedTimestamp": "2018-12-20T18:38:02.181Z",
        "DefaultLicense": "Pro",
        "SupportedLicenses": [
            "Basic",
            "Pro"
        ],
        "SigninDelegateGroups": [
            {
                "GroupName": "myGroup"
            },
        ]
    }
}

Pour plus d’informations, consultez Managing Your Amazon Chime Accounts dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

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

L’exemple get-bot suivant affiche les informations du bot spécifié.

aws chime get-bot \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

Sortie :

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": false,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
}

Pour plus d’informations, consultez Mise à jour des chatbots dans le Manuel du développeur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser get-global-settings.

AWS CLI

Pour obtenir les paramètres globaux

L’exemple get-global-settings suivant récupère les noms des compartiments S3 utilisés pour stocker les enregistrements détaillés des appels pour Amazon Chime Business Calling et les connecteurs vocaux Amazon Chime associés au compte AWS de l’administrateur.

aws chime get-global-settings

Sortie :

{
    "BusinessCalling": {
        "CdrBucket": "s3bucket"
    },
    "VoiceConnector": {
        "CdrBucket": "s3bucket"
    }
}

Pour plus d’informations, consultez Gestion des paramètres généraux dans le Guide de l’administrateur d’Amazon Chime.

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

L’exemple de code suivant montre comment utiliser get-phone-number-order.

AWS CLI

Pour obtenir les informations sur l’ordre de numéros de téléphone

L’exemple get-phone-number-order suivant affiche les informations sur l’ordre des numéros de téléphone spécifiés.

aws chime get-phone-number-order \
    --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012

Sortie :

{
    "PhoneNumberOrder": {
        "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012",
        "ProductType": "VoiceConnector",
        "Status": "Partial",
        "OrderedPhoneNumbers": [
            {
              "E164PhoneNumber": "+12065550100",
              "Status": "Acquired"
            },
            {
                "E164PhoneNumber": "+12065550101",
                "Status": "Acquired"
            },
            {
                "E164PhoneNumber": "+12065550102",
                "Status": "Failed"
            }
        ],
        "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
        "UpdatedTimestamp": "2019-08-09T21:35:31.926Z"
    }
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser get-phone-number-settings.

AWS CLI

Pour récupérer le nom d’un appel sortant

L’exemple get-phone-number-settings suivant récupère le nom d’un appel sortant par défaut pour le compte AWS de l’utilisateur effectuant l’appel.

aws chime get-phone-number-settings

Cette commande ne produit aucune sortie. Sortie :

{
    "CallingName": "myName",
    "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z"
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser get-phone-number.

AWS CLI

Pour obtenir les informations sur un numéro de téléphone

L’exemple get-phone-number suivant affiche les informations du numéro de téléphone spécifié.

aws chime get-phone-number \
    --phone-number-id +12065550100

Sortie :

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "VoiceConnector",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
       "Associations": [
            {
                "Value": "abcdef1ghij2klmno3pqr4",
                "Name": "VoiceConnectorId",
                "AssociatedTimestamp": "2019-10-28T18:40:37.453Z"
            }
        ],
        "CallingNameStatus": "UpdateInProgress",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-09T21:35:31.745Z"
    }
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour obtenir les informations sur une salle de conversation

L’exemple get-room suivant affiche les informations sur la salle de conversation spécifiée.

aws chime get-room \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Sortie :

{
    "Room": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Name": "chatRoom",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "CreatedBy": "arn:aws:iam::111122223333:user/alejandro",
        "CreatedTimestamp": "2019-12-02T22:29:31.549Z",
        "UpdatedTimestamp": "2019-12-02T22:29:31.549Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour récupérer des paramètres utilisateur

L’exemple get-user-settings suivant affiche les paramètres utilisateur spécifiés.

aws chime get-user-settings \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

Sortie :

{
    "UserSettings": {
        "Telephony": {
            "InboundCalling": true,
            "OutboundCalling": true,
            "SMS": true
        }
    }
}

Pour plus d’informations, consultez Gestion des numéros de téléphone de l’utilisateur dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour obtenir les informations concernant un utilisateur

L’exemple get-user suivant récupère les informations concernant l’utilisateur spécifié.

aws chime get-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Sortie :

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "PrimaryEmail": "marthar@example.com",
        "DisplayName": "Martha Rivera",
        "LicenseType": "Pro",
        "UserRegistrationStatus": "Registered",
        "RegisteredOn": "2018-12-20T18:45:25.231Z",
        "InvitedOn": "2018-12-20T18:45:25.231Z",
        "AlexaForBusinessMetadata": {
            "IsAlexaForBusinessEnabled": False,
            "AlexaForBusinessRoomArn": "null"
        },
        "PersonalPIN": "XXXXXXXXXX"
    }
}

Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide de l’administrateur d’Amazon Chime.

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

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

AWS CLI

Pour inviter des utilisateurs à rejoindre Amazon Chime

L’exemple invite-users suivant envoie un e-mail pour inviter un utilisateur à rejoindre le compte Amazon Chime spécifié.

aws chime invite-users \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-email-list "alejandror@example.com" "janed@example.com"

Sortie :

{
    "Invites": [
        {
            "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "Status": "Pending",
            "EmailAddress": "alejandror@example.com",
            "EmailStatus": "Sent"
        }
        {
            "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "Status": "Pending",
            "EmailAddress": "janed@example.com",
            "EmailStatus": "Sent"
        }
    ]
}

Pour plus d’informations, consultez Invitation et suspension des utilisateurs dans le Guide de l’administrateur d’Amazon Chime.

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

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

AWS CLI

Pour obtenir une liste des comptes

L’exemple list-accounts suivant récupère une liste des comptes Amazon Chime du compte AWS de l’administrateur.

aws chime list-accounts

Sortie :

{
    "Accounts": [
        {
            "AwsAccountId": "111122223333",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "Name": "First Chime Account",
            "AccountType": "EnterpriseDirectory",
            "CreatedTimestamp": "2018-12-20T18:38:02.181Z",
            "DefaultLicense": "Pro",
            "SupportedLicenses": [
                "Basic",
                "Pro"
            ],
            "SigninDelegateGroups": [
                {
                    "GroupName": "myGroup"
                },
            ]
        },
        {
            "AwsAccountId": "111122223333",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "Name": "Second Chime Account",
            "AccountType": "Team",
            "CreatedTimestamp": "2018-09-04T21:44:22.292Z",
            "DefaultLicense": "Pro",
            "SupportedLicenses": [
                "Basic",
                "Pro"
            ],
            "SigninDelegateGroups": [
                {
                    "GroupName": "myGroup"
                },
            ]
        }
    ]
}

Pour plus d’informations, consultez Managing Your Amazon Chime Accounts dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour récupérer une liste de bots

L’exemple list-bots suivant répertorie les bots associés au compte Amazon Chime Enterprise spécifié.

aws chime list-bots \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45

Sortie :

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": false,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
}

Pour plus d’informations, consultez Utilisation de chatbots avec Amazon Chime dans le Manuel du développeur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser list-phone-number-orders.

AWS CLI

Pour répertorier l’ordre de numéros de téléphone

L’exemple list-phone-number-orders suivant répertorie l’ordre des numéros de téléphone associés au compte de l’administrateur Amazon Chime.

aws chime list-phone-number-orders

Sortie :

{
    "PhoneNumberOrders": [
        {
            "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012",
            "ProductType": "VoiceConnector",
            "Status": "Partial",
            "OrderedPhoneNumbers": [
                {
                    "E164PhoneNumber": "+12065550100",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550101",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550102",
                    "Status": "Failed"
                }
            ],
            "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
            "UpdatedTimestamp": "2019-08-09T21:35:31.926Z"
        }
        {
            "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109",
            "ProductType": "BusinessCalling",
            "Status": "Partial",
            "OrderedPhoneNumbers": [
                {
                    "E164PhoneNumber": "+12065550103",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550104",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550105",
                    "Status": "Failed"
                }
            ],
            "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
            "UpdatedTimestamp": "2019-08-09T21:35:31.926Z"
        }
    ]
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour répertorier les numéros de téléphone d’un compte Amazon Chime

L’exemple list-phone-numbers suivant répertorie les numéros de téléphone associés au compte Amazon Chime de l’administrateur.

aws chime list-phone-numbers

Cette commande ne produit aucune sortie. Sortie :

{
    "PhoneNumbers": [
        {
            "PhoneNumberId": "%2B12065550100",
            "E164PhoneNumber": "+12065550100",
            "Type": "Local",
            "ProductType": "VoiceConnector",
            "Status": "Assigned",
            "Capabilities": {
                "InboundCall": true,
                "OutboundCall": true,
                "InboundSMS": true,
                "OutboundSMS": true,
                "InboundMMS": true,
                "OutboundMMS": true
            },
            "Associations": [
                {
                    "Value": "abcdef1ghij2klmno3pqr4",
                    "Name": "VoiceConnectorId",
                    "AssociatedTimestamp": "2019-10-28T18:40:37.453Z"
                }
            ],
            "CallingNameStatus": "UpdateInProgress",
            "CreatedTimestamp": "2019-08-12T22:10:20.521Z",
            "UpdatedTimestamp": "2019-10-28T18:42:07.964Z"
        },
        {
            "PhoneNumberId": "%2B12065550101",
            "E164PhoneNumber": "+12065550101",
            "Type": "Local",
            "ProductType": "VoiceConnector",
            "Status": "Assigned",
            "Capabilities": {
                "InboundCall": true,
                "OutboundCall": true,
                "InboundSMS": true,
                "OutboundSMS": true,
                "InboundMMS": true,
                "OutboundMMS": true
            },
            "Associations": [
                {
                    "Value": "abcdef1ghij2klmno3pqr4",
                    "Name": "VoiceConnectorId",
                    "AssociatedTimestamp": "2019-10-28T18:40:37.511Z"
                }
            ],
            "CallingNameStatus": "UpdateInProgress",
            "CreatedTimestamp": "2019-08-12T22:10:20.521Z",
            "UpdatedTimestamp": "2019-10-28T18:42:07.960Z"
        }
    ]
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour répertorier les adhésions aux salles

L’exemple list-room-memberships suivant affiche une liste des informations relatives aux adhésions pour la salle de conversation spécifiée.

aws chime list-room-memberships \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Sortie :

{
    "RoomMemberships": [
        {
            "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
            "Member": {
                "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k",
                "MemberType": "User",
                "Email": "zhangw@example.com",
                "FullName": "Zhang Wei",
                "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
            },
            "Role": "Member",
            "InvitedBy": "arn:aws:iam::111122223333:user/alejandro",
            "UpdatedTimestamp": "2019-12-02T22:46:58.532Z"
        },
        {
            "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
            "Member": {
                "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k",
                "MemberType": "User",
                "Email": "janed@example.com",
                "FullName": "Jane Doe",
                "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
            },
            "Role": "Administrator",
            "InvitedBy": "arn:aws:iam::111122223333:user/alejandro",
            "UpdatedTimestamp": "2019-12-02T22:46:58.532Z"
        }
    ]
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour répertorier les salles de conversation

L’exemple list-rooms suivant affiche une liste des salles de conversation pour le compte spécifié. La liste est filtrée uniquement pour les salles de conversation auxquelles appartient le membre spécifié.

aws chime list-rooms \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Sortie :

{
    "Room": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Name": "teamRoom",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "CreatedBy": "arn:aws:iam::111122223333:user/alejandro",
        "CreatedTimestamp": "2019-12-02T22:29:31.549Z",
        "UpdatedTimestamp": "2019-12-02T22:33:19.310Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

  • Pour plus de détails sur l’API, consultez ListRooms 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épertorier tous les utilisateurs d’un compte

L’exemple list-users suivant répertorie les utilisateurs du compte Amazon Chime spécifié.

aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Sortie :

{
    "Users": [
        {
            "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "PrimaryEmail": "mariag@example.com",
            "DisplayName": "Maria Garcia",
            "LicenseType": "Pro",
            "UserType": "PrivateUser",
            "UserRegistrationStatus": "Registered",
            "RegisteredOn": "2018-12-20T18:45:25.231Z"
            "AlexaForBusinessMetadata": {
                "IsAlexaForBusinessEnabled": false
            }
        },
        {
            "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "PrimaryEmail": "richardr@example.com",
            "DisplayName": "Richard Roe",
            "LicenseType": "Pro",
            "UserType": "PrivateUser",
            "UserRegistrationStatus": "Registered",
            "RegisteredOn": "2018-12-20T18:45:45.415Z"
            "AlexaForBusinessMetadata": {
                "IsAlexaForBusinessEnabled": false
            }
        },
        {
            "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "PrimaryEmail": "saanvis@example.com",
            "DisplayName": "Saanvi Sarkar",
            "LicenseType": "Basic",
            "UserType": "PrivateUser",
            "UserRegistrationStatus": "Registered",
            "RegisteredOn": "2018-12-20T18:46:57.747Z"
            "AlexaForBusinessMetadata": {
                "IsAlexaForBusinessEnabled": false
            }
        },
        {
            "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "PrimaryEmail": "wxiulan@example.com",
            "DisplayName": "Wang Xiulan",
            "LicenseType": "Basic",
            "UserType": "PrivateUser",
            "UserRegistrationStatus": "Registered",
            "RegisteredOn": "2018-12-20T18:47:15.390Z"
            "AlexaForBusinessMetadata": {
                "IsAlexaForBusinessEnabled": false
            }
        }
    ]
}

Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide de l’administrateur d’Amazon Chime.

  • 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 logout-user.

AWS CLI

Pour déconnecter un utilisateur

L’exemple logout-user suivant déconnecte l’utilisateur spécifié.

aws chime logout-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Cette commande ne produit aucune sortie.

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

L’exemple de code suivant montre comment utiliser regenerate-security-token.

AWS CLI

Pour régénérer un jeton de sécurité

L’exemple regenerate-security-token suivant régénère le jeton de sécurité pour le bot spécifié.

aws chime regenerate-security-token \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

Sortie :

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": false,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY"
    }
}

Pour plus d’informations, consultez Authentification des demandes de chatbots dans le Manuel du développeur Amazon Chime.

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

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

AWS CLI

Pour réinitialiser le code PIN de réunion personnel d’un utilisateur

L’exemple reset-personal-pin suivant réinitialise le code PIN de réunion personnel de l’utilisateur spécifié.

aws chime reset-personal-pin \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Sortie :

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "PrimaryEmail": "mateo@example.com",
        "DisplayName": "Mateo Jackson",
        "LicenseType": "Pro",
        "UserType": "PrivateUser",
        "UserRegistrationStatus": "Registered",
        "RegisteredOn": "2018-12-20T18:45:25.231Z",
        "AlexaForBusinessMetadata": {
            "IsAlexaForBusinessEnabled": False,
            "AlexaForBusinessRoomArn": "null"
        },
        "PersonalPIN": "XXXXXXXXXX"
    }
}

Pour plus d’informations, consultez Modification des codes PIN personnels de réunion dans le Guide de l’administrateur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser restore-phone-number.

AWS CLI

Pour restaurer un numéro de téléphone

L’exemple restore-phone-number suivant restaure le numéro de téléphone spécifié à partir de la file d’attente de suppression.

aws chime restore-phone-number \
    --phone-number-id "+12065550100"

Sortie :

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "BusinessCalling",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
        "Associations": [],
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-12T22:06:36.355Z"
    }
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

L’exemple de code suivant montre comment utiliser search-available-phone-numbers.

AWS CLI

Pour rechercher les numéros de téléphone disponibles

L’exemple search-available-phone-numbers suivant recherche les numéros de téléphone disponibles par indicatif.

aws chime search-available-phone-numbers \
    --area-code "206"

Sortie :

{
    "E164PhoneNumbers": [
        "+12065550100",
        "+12065550101",
        "+12065550102",
        "+12065550103",
        "+12065550104",
        "+12065550105",
        "+12065550106",
        "+12065550107",
        "+12065550108",
        "+12065550109",
    ]
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

AWS CLI

Pour mettre à jour les paramètres de votre compte

L’exemple update-account-settings suivant désactive le contrôle à distance des écrans partagés pour le compte Amazon Chime spécifié.

aws chime update-account-settings \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --account-settings DisableRemoteControl=true

Cette commande ne produit aucune sortie.

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

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

AWS CLI

Pour mettre à jour un compte

L’exemple update-account suivant met à jour le nom du compte spécifié.

aws chime update-account \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --name MyAccountName

Sortie :

{
    "Account": {
        "AwsAccountId": "111122223333",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "Name": "MyAccountName",
        "AccountType": "Team",
        "CreatedTimestamp": "2018-09-04T21:44:22.292Z",
        "DefaultLicense": "Pro",
        "SupportedLicenses": [
            "Basic",
            "Pro"
        ],
        "SigninDelegateGroups": [
            {
                "GroupName": "myGroup"
            },
        ]
    }
}

Pour plus d’informations, consultez Attribution d’un nouveau nom à votre compte dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour un bot

L’exemple update-bot suivant met à jour le statut du bot spécifié pour arrêter son exécution.

aws chime update-bot \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \
    --disabled

Sortie :

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": true,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY"
    }
}

Pour plus d’informations, consultez Mise à jour des chatbots dans le Manuel du développeur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour les paramètres généraux

L’exemple update-global-settings suivant met à jour le compartiment S3 utilisé pour stocker les enregistrements détaillés des appels pour Amazon Chime Business Calling et les connecteurs vocaux Amazon Chime associés au compte AWS de l’administrateur.

aws chime update-global-settings \
    --business-calling CdrBucket="s3bucket" \
    --voice-connector CdrBucket="s3bucket"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des paramètres généraux dans le Guide de l’administrateur d’Amazon Chime.

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

L’exemple de code suivant montre comment utiliser update-phone-number-settings.

AWS CLI

Pour mettre à jour le nom d’un appel sortant

L’exemple update-phone-number-settings suivant met à jour le nom d’un appel sortant par défaut pour le compte AWS de l’administrateur.

aws chime update-phone-number-settings \
    --calling-name "myName"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

AWS CLI

Exemple 1 : pour mettre à jour le type de produit pour un numéro de téléphone

L’exemple update-phone-number suivant met à jour le type de produit du numéro de téléphone spécifié.

aws chime update-phone-number \
    --phone-number-id "+12065550100" \
    --product-type "BusinessCalling"

Sortie :

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "BusinessCalling",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
        "Associations": [],
        "CallingName": "phonenumber1",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-12T21:44:07.591Z"
    }
}

Exemple 2 : pour mettre à jour le nom d’un appel sortant pour un numéro de téléphone

L’exemple update-phone-number suivant met à jour le nom de l’appel sortant pour le numéro de téléphone spécifié.

aws chime update-phone-number --phone-number-id "+12065550100" --calling-name "phonenumber2"

Sortie :

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "BusinessCalling",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
        "Associations": [],
        "CallingName": "phonenumber2",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-12T21:44:07.591Z"
    }
}

Pour plus d’informations, consultez Utilisation des numéros de téléphone dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour l’adhésion à une salle de conversation

L’exemple update-room-membership suivant modifie le rôle du membre de la salle de conversation spécifiée comme Administrator.

aws chime update-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --role Administrator

Sortie :

{
    "RoomMembership": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Member": {
            "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k",
            "MemberType": "User",
            "Email": "sofiamartinez@example.com",
            "FullName": "Sofia Martinez",
            "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
        },
        "Role": "Administrator",
        "InvitedBy": "arn:aws:iam::111122223333:user/admin",
        "UpdatedTimestamp": "2019-12-02T22:40:22.931Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour créer une salle de conversation

L’exemple update-room suivant modifie le nom de la salle de conversation spécifiée.

aws chime update-room \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --name teamRoom

Sortie :

{
    "Room": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Name": "teamRoom",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "CreatedBy": "arn:aws:iam::111122223333:user/alejandro",
        "CreatedTimestamp": "2019-12-02T22:29:31.549Z",
        "UpdatedTimestamp": "2019-12-02T22:33:19.310Z"
    }
}

Pour plus d’informations, consultez Créer une salle de conversation dans le Guide de l’utilisateur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour les paramètres utilisateur

L’exemple update-user-settings suivant permet à l’utilisateur spécifié de passer des appels entrants et sortants et d’envoyer et de recevoir des SMS.

aws chime update-user-settings \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion des numéros de téléphone de l’utilisateur dans le Guide de l’administrateur Amazon Chime.

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

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

AWS CLI

Pour mettre à jour les informations de l’utilisateur

Cet exemple met à jour les informations spécifiées pour l’utilisateur spécifié.

Commande :

aws chime update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \
    --license-type "Basic"

Sortie :

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    }
}

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