diff --git a/awscli/examples/ds-data/add-group-member.rst b/awscli/examples/ds-data/add-group-member.rst new file mode 100644 index 000000000000..45c54d26ab41 --- /dev/null +++ b/awscli/examples/ds-data/add-group-member.rst @@ -0,0 +1,12 @@ +**To add a group member to a directory** + +The following ``add-group-member`` example adds the specified user to the specified group in the specified directory. :: + + aws ds-data add-group-member \ + --directory-id d-1234567890 \ + --group-name 'sales' \ + --member-name 'john.doe' + +This command produces no output. + +For more information, see `Adding or removing AWS Managed Microsoft AD members to groups and groups to groups `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/create-group.rst b/awscli/examples/ds-data/create-group.rst new file mode 100644 index 000000000000..9451cebd2c78 --- /dev/null +++ b/awscli/examples/ds-data/create-group.rst @@ -0,0 +1,17 @@ +**To create a group for a directory** + +The following ``create-group`` example creates a group in the specified directory. :: + + aws ds-data create-group \ + --directory-id d-1234567890 \ + --sam-account-name 'sales' + +Output:: + + { + "DirectoryId": "d-9067f3da7a", + "SAMAccountName": "sales", + "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" + } + +For more information, see `Creating an AWS Managed Microsoft AD group `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/create-user.rst b/awscli/examples/ds-data/create-user.rst new file mode 100644 index 000000000000..f348abf0bce6 --- /dev/null +++ b/awscli/examples/ds-data/create-user.rst @@ -0,0 +1,17 @@ +**To create a user** + +The following ``create-user`` example creates a user in the specified directory. :: + + aws ds-data create-user \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' + +Output:: + + { + "DirectoryId": "d-1234567890", + "SAMAccountName": "john.doe", + "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" + } + +For more information, see `Creating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/delete-group.rst b/awscli/examples/ds-data/delete-group.rst new file mode 100644 index 000000000000..33c155c7ffbf --- /dev/null +++ b/awscli/examples/ds-data/delete-group.rst @@ -0,0 +1,11 @@ +**To delete a group** + +The following ``delete-group`` example deletes the specified group from the specified directory. :: + + aws ds-data delete-group \ + --directory-id d-1234567890 \ + --sam-account-name 'sales' + +This command produces no output. + +For more information, see `Deleting an AWS Managed Microsoft AD group `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/delete-user.rst b/awscli/examples/ds-data/delete-user.rst new file mode 100644 index 000000000000..9ffd38f8ea04 --- /dev/null +++ b/awscli/examples/ds-data/delete-user.rst @@ -0,0 +1,11 @@ +**To delete a user** + +The following ``delete-user`` example deletes the specified user from the specified directory. :: + + aws ds-data delete-user \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' + +This command produces no output. + +For more information, see `Deleting an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/describe-group.rst b/awscli/examples/ds-data/describe-group.rst new file mode 100644 index 000000000000..ef8b227a6864 --- /dev/null +++ b/awscli/examples/ds-data/describe-group.rst @@ -0,0 +1,21 @@ +**To list details of a group** + +The following ``describe-group`` example gets information for the specified group in the specified directory. :: + + aws ds-data describe-group \ + --directory-id d-1234567890 \ + --sam-account-name 'sales' + +Output:: + + { + "DirectoryId": "d-1234567890", + "DistinguishedName": "CN=sales,OU=Users,OU=CORP,DC=corp,DC=example,DC=com", + "GroupScope": "Global", + "GroupType": "Security", + "Realm": "corp.example.com", + "SAMAccountName": "sales", + "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/describe-user.rst b/awscli/examples/ds-data/describe-user.rst new file mode 100644 index 000000000000..1ea210ad962c --- /dev/null +++ b/awscli/examples/ds-data/describe-user.rst @@ -0,0 +1,21 @@ +**To list information for a user** + +The following ``describe-user`` example gets information for the specified user in the specified directory. :: + + aws ds-data describe-user command-name \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' + +Output:: + + { + "DirectoryId": "d-1234567890", + "DistinguishedName": "CN=john.doe,OU=Users,OU=CORP,DC=corp,DC=example,DC=com", + "Enabled": false, + "Realm": "corp.example.com", + "SAMAccountName": "john.doe", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567", + "UserPrincipalName": "john.doe@CORP.EXAMPLE.COM" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/disable-directory-data-access.rst b/awscli/examples/ds-data/disable-directory-data-access.rst new file mode 100644 index 000000000000..e02e870b7ab3 --- /dev/null +++ b/awscli/examples/ds-data/disable-directory-data-access.rst @@ -0,0 +1,10 @@ +**To disable Directory Service Data API for a directory** + +The following ``disable-directory-data-access`` example disables the Directory Service Data API for the specified directory. :: + + aws ds disable-directory-data-access \ + --directory-id d-1234567890 + +This command produces no output. + +For more information, see `Enabling or disabling user and group management or AWS Directory Service Data `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/disable-user.rst b/awscli/examples/ds-data/disable-user.rst new file mode 100644 index 000000000000..fc71978b8583 --- /dev/null +++ b/awscli/examples/ds-data/disable-user.rst @@ -0,0 +1,11 @@ +**To disable a user** + +The following ``disable-user`` example disables the specified user in the specified directory. :: + + aws ds-data disable-user \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' + +This command produces no output. + +For more information, see `Disabling an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/enable-directory-data-access.rst b/awscli/examples/ds-data/enable-directory-data-access.rst new file mode 100644 index 000000000000..2be21265a81a --- /dev/null +++ b/awscli/examples/ds-data/enable-directory-data-access.rst @@ -0,0 +1,10 @@ +**To enable Directory Service Data API for a directory** + +The following ``enable-directory-data-access`` example enables the Directory Service Data API for the specified directory. :: + + aws ds enable-directory-data-access \ + --directory-id d-1234567890 + +This command produces no output. + +For more information, see `Enabling or disabling user and group management or AWS Directory Service Data `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/list-group-members.rst b/awscli/examples/ds-data/list-group-members.rst new file mode 100644 index 000000000000..157d632a6533 --- /dev/null +++ b/awscli/examples/ds-data/list-group-members.rst @@ -0,0 +1,29 @@ +**To list a directory's group members** + +The following ``list-group-members`` example lists the group members for the specified group in the specified directory. :: + + aws ds-data list-group-members \ + --directory-id d-1234567890 \ + --sam-account-name 'sales' + +Output:: + + { + "Members": [ + { + "MemberType": "USER", + "SAMAccountName": "Jane Doe", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" + }, + { + "MemberType": "USER", + "SAMAccountName": "John Doe", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4569" + } + ], + "DirectoryId": "d-1234567890", + "MemberRealm": "corp.example.com", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/list-groups-for-member.rst b/awscli/examples/ds-data/list-groups-for-member.rst new file mode 100644 index 000000000000..1ac8a8746fc2 --- /dev/null +++ b/awscli/examples/ds-data/list-groups-for-member.rst @@ -0,0 +1,25 @@ +**To list a directory's group membership** + +The following ``list-groups-for-member`` example lists group membership for the specified user in the specified directory. :: + + aws ds-data list-groups-for-member \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' + +Output:: + + { + "Groups": [ + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Users", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + } + ], + "DirectoryId": "d-1234567890", + "MemberRealm": "corp.example.com", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/list-groups.rst b/awscli/examples/ds-data/list-groups.rst new file mode 100644 index 000000000000..d01ce5f2b981 --- /dev/null +++ b/awscli/examples/ds-data/list-groups.rst @@ -0,0 +1,503 @@ +**To list a directory's groups** + +The following ``list-groups`` example lists groups in the specified directory. :: + + aws ds-data list-groups \ + --directory-id d-1234567890 + +Output:: + + { + "Groups": [ + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Administrators", + "SID": "S-1-2-33-441" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Users", + "SID": "S-1-2-33-442" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Guests", + "SID": "S-1-2-33-443" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Print Operators", + "SID": "S-1-2-33-444" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Backup Operators", + "SID": "S-1-2-33-445" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Replicator", + "SID": "S-1-2-33-446" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Remote Desktop Users", + "SID": "S-1-2-33-447" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Network Configuration Operators", + "SID": "S-1-2-33-448" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Performance Monitor Users", + "SID": "S-1-2-33-449" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Performance Log Users", + "SID": "S-1-2-33-450" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Distributed COM Users", + "SID": "S-1-2-33-451" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "IIS_IUSRS", + "SID": "S-1-2-33-452" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Cryptographic Operators", + "SID": "S-1-2-33-453" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Event Log Readers", + "SID": "S-1-2-33-454" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Certificate Service DCOM Access", + "SID": "S-1-2-33-456" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "RDS Remote Access Servers", + "SID": "S-1-2-33-457" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "RDS Endpoint Servers", + "SID": "S-1-2-33-458" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "RDS Management Servers", + "SID": "S-1-2-33-459" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Hyper-V Administrators", + "SID": "S-1-2-33-460" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Access Control Assistance Operators", + "SID": "S-1-2-33-461" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Remote Management Users", + "SID": "S-1-2-33-462" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Storage Replica Administrators", + "SID": "S-1-2-33-463" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Computers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-789" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Controllers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-790" + }, + { + "GroupScope": "Universal", + "GroupType": "Security", + "SAMAccountName": "Schema Admins", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-791" + }, + { + "GroupScope": "Universal", + "GroupType": "Security", + "SAMAccountName": "Enterprise Admins", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-792" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "Cert Publishers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-793" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Admins", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-794" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Users", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-795" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Domain Guests", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-796" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Group Policy Creator Owners", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-797" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "RAS and IAS Servers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-798" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Server Operators", + "SID": "S-1-2-33-464" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Account Operators", + "SID": "S-1-2-33-465" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Pre-Windows 2000 Compatible Access", + "SID": "S-1-2-33-466" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Incoming Forest Trust Builders", + "SID": "S-1-2-33-467" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Windows Authorization Access Group", + "SID": "S-1-2-33-468" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Terminal Server License Servers", + "SID": "S-1-2-33-469" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "Allowed RODC Password Replication Group", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-798" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "Denied RODC Password Replication Group", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-799" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Read-only Domain Controllers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-800" + }, + { + "GroupScope": "Universal", + "GroupType": "Security", + "SAMAccountName": "Enterprise Read-only Domain Controllers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-801" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Cloneable Domain Controllers", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-802" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Protected Users", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-803" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Key Admins", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-804" + }, + { + "GroupScope": "Universal", + "GroupType": "Security", + "SAMAccountName": "Enterprise Key Admins", + "SID": "S-1-2-34-56789123456-7891012345-6789123486-805" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "DnsAdmins", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "DnsUpdateProxy", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "Admins", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4569" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWSAdministrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4570" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Object Management Service Accounts", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4571" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Private CA Connector for AD Delegated Group", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4572" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Application and Service Delegated Group", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4573" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4574" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated FSx Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4575" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Account Operators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4576" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Active Directory Based Activation Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4577" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Allowed to Authenticate Objects", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4578" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Allowed to Authenticate to Domain Controllers", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4579" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Deleted Object Lifetime Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4580" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Distributed File System Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4581" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Dynamic Host Configuration Protocol Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4582" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Enterprise Certificate Authority Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4583" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Fine Grained Password Policy Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4584" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Group Policy Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4585" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Managed Service Account Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4586" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Read Foreign Security Principals", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4587" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Remote Access Service Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4588" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Replicate Directory Changes Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4588" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Sites and Services Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4589" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated System Management Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4590" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Terminal Server Licensing Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4591" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated User Principal Name Suffix Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4592" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Add Workstations To Domain Users", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4593" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Domain Name System Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4594" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Kerberos Delegation Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4595" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated Server Administrators", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4596" + }, + { + "GroupScope": "DomainLocal", + "GroupType": "Security", + "SAMAccountName": "AWS Delegated MS-NPRC Non-Compliant Devices", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4597" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Remote Access", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4598" + }, + { + "GroupScope": "Global", + "GroupType": "Security", + "SAMAccountName": "Accounting", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4599" + }, + { + "GroupScope": "Global", + "GroupType": "Distribution", + "SAMAccountName": "sales", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + } + ], + "DirectoryId": "d-1234567890", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/list-users.rst b/awscli/examples/ds-data/list-users.rst new file mode 100644 index 000000000000..6b3a43792c82 --- /dev/null +++ b/awscli/examples/ds-data/list-users.rst @@ -0,0 +1,57 @@ +**To list a directory's users** + +The following ``list-users`` example lists users in the specified directory. :: + + aws ds-data list-users \ + --directory-id d-1234567890 + +Output:: + + { + "Users": [ + { + "Enabled": true, + "SAMAccountName": "Administrator", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-345" + }, + { + "Enabled": false, + "SAMAccountName": "Guest", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-345" + }, + { + "Enabled": false, + "SAMAccountName": "krbtgt", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-346" + }, + { + "Enabled": true, + "SAMAccountName": "Admin", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-347" + }, + { + "Enabled": true, + "SAMAccountName": "Richard Roe", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-348" + }, + { + "Enabled": true, + "SAMAccountName": "Jane Doe", + "SID": "S-1-2-34-5678910123-4567895012-3456789012-349" + }, + { + "Enabled": true, + "SAMAccountName": "AWS_WGnzYlN6YyY", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + }, + { + "Enabled": true, + "SAMAccountName": "john.doe", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" + } + ], + "DirectoryId": "d-1234567890", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/remove-group-member.rst b/awscli/examples/ds-data/remove-group-member.rst new file mode 100644 index 000000000000..a44c8313c693 --- /dev/null +++ b/awscli/examples/ds-data/remove-group-member.rst @@ -0,0 +1,12 @@ +**To remove a group member from a directory** + +The following ``remove-group-member`` example removes the specified group member from the specified group in the specified directory. :: + + aws ds-data remove-group-member \ + --directory-id d-1234567890 \ + --group-name 'sales' \ + --member-name 'john.doe' + +This command produces no output. + +For more information, see `Adding and removing AWS Managed Microsoft AD members to groups and groups to groups `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/reset-user-password.rst b/awscli/examples/ds-data/reset-user-password.rst new file mode 100644 index 000000000000..524985116969 --- /dev/null +++ b/awscli/examples/ds-data/reset-user-password.rst @@ -0,0 +1,12 @@ +**To reset a user password in a directory** + +The following ``reset-user-password`` example resets and enables the specified user in the specified directory. :: + + aws ds reset-user-password \ + --directory-id d-1234567890 \ + --user-name 'john.doe' \ + --new-password 'password' + +This command produces no output. + +For more information, see `Resetting and enabling an AWS Managed Microsoft AD user's password `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/search-groups.rst b/awscli/examples/ds-data/search-groups.rst new file mode 100644 index 000000000000..dc8fb354d55b --- /dev/null +++ b/awscli/examples/ds-data/search-groups.rst @@ -0,0 +1,25 @@ +**To search for a group in a directory** + +The following ``search-groups`` example searches for the specified group in the specified directory. :: + + aws ds-data search-groups \ + --directory-id d-1234567890 \ + --search-attributes 'SamAccountName' \ + --search-string 'sales' + +Output:: + + { + "Groups": [ + { + "GroupScope": "Global", + "GroupType": "Distribution", + "SAMAccountName": "sales", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + } + ], + "DirectoryId": "d-1234567890", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/search-users.rst b/awscli/examples/ds-data/search-users.rst new file mode 100644 index 000000000000..091b99e7a423 --- /dev/null +++ b/awscli/examples/ds-data/search-users.rst @@ -0,0 +1,24 @@ +**To search for a user in a directory** + +The following ``search-users`` example searches for the specified user in the specified directory. :: + + aws ds-data search-users \ + --directory-id d-1234567890 \ + --search-attributes 'SamAccountName' \ + --Search-string 'john.doe' + +Output:: + + { + "Users": [ + { + "Enabled": true, + "SAMAccountName": "john.doe", + "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" + } + ], + "DirectoryId": "d-1234567890", + "Realm": "corp.example.com" + } + +For more information, see `Viewing and updating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/update-group.rst b/awscli/examples/ds-data/update-group.rst new file mode 100644 index 000000000000..e4198aa3e2de --- /dev/null +++ b/awscli/examples/ds-data/update-group.rst @@ -0,0 +1,13 @@ +**To update a group's attribute in a directory** + +The following ``update-group`` example updates the specified attribute for the specified group in the specified directory. :: + + aws ds-data update-group \ + --directory-id d-1234567890 \ + --sam-account-name 'sales' \ + --update-type 'REPLACE' \ + --group-type 'Distribution' + +This command produces no output. + +For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ds-data/update-user.rst b/awscli/examples/ds-data/update-user.rst new file mode 100644 index 000000000000..08f82ae3d838 --- /dev/null +++ b/awscli/examples/ds-data/update-user.rst @@ -0,0 +1,13 @@ +**To update a user's attribute in a directory** + +The following ``update-user`` example updates the specified attribute for the specified user in the specified directory. :: + + aws ds-data update-user \ + --directory-id d-1234567890 \ + --sam-account-name 'john.doe' \ + --update-type 'ADD' \ + --email-address 'example.corp.com' + +This command produces no output. + +For more information, see `Viewing and updating an AWS Managed Microsoft AD user `__ in the *AWS Directory Service Administration Guide*. diff --git a/awscli/examples/ecr-public/get-registry-catalog-data.rst b/awscli/examples/ecr-public/get-registry-catalog-data.rst new file mode 100644 index 000000000000..e293089a41af --- /dev/null +++ b/awscli/examples/ecr-public/get-registry-catalog-data.rst @@ -0,0 +1,14 @@ +**To retrieve catalog metadata for a public ECR registry** + +The following ``get-registry-catalog-data`` retrieves catalog metadata for an ECR public registry. :: + + aws ecr-public get-registry-catalog-data \ + --region us-east-1 + +Output:: + + { + "registryCatalogData": { + "displayName": "YourCustomPublicRepositoryalias" + } + } diff --git a/awscli/examples/ecr-public/get-repository-catalog-data.rst b/awscli/examples/ecr-public/get-repository-catalog-data.rst new file mode 100644 index 000000000000..b3db31e94692 --- /dev/null +++ b/awscli/examples/ecr-public/get-repository-catalog-data.rst @@ -0,0 +1,29 @@ +**To retrieve catalog metadata for a repository in a public registry** + +The following ``get-repository-catalog-data`` example lists the catalog metadata for the repository ``project-a/nginx-web-app`` in a public registry. :: + + aws ecr-public get-repository-catalog-data \ + --repository-name project-a/nginx-web-app \ + --region us-east-1 + +Output:: + + { + "catalogData": { + "description": "My project-a ECR Public Repository", + "architectures": [ + "ARM", + "ARM 64", + "x86", + "x86-64" + ], + "operatingSystems": [ + "Linux" + ], + "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/491d3846-8f33-4d8b-a10c-c2ce271e6c0d/4f09d87c-2569-4916-a932-5c296bf6f88a.png", + "aboutText": "## Quick reference\n\nMaintained ", + "usageText": "## Supported architectures\n\namd64, arm64v8\n\n## " + } + } + +For more information, see `Repository catalog data `__ in the *Amazon ECR Public*. \ No newline at end of file diff --git a/awscli/examples/ecr-public/list-tags-for-resource.rst b/awscli/examples/ecr-public/list-tags-for-resource.rst new file mode 100644 index 000000000000..fd700be2205f --- /dev/null +++ b/awscli/examples/ecr-public/list-tags-for-resource.rst @@ -0,0 +1,28 @@ +**To list tags for a public repository in a public registry** + +The following ``list-tags-for-resource`` example lists the tags for a resource named ``project-a/nginx-web-app`` in a public registry. :: + + aws ecr-public list-tags-for-resource \ + --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ + --region us-east-1 + +Output:: + + { + "tags": [ + { + "Key": "Environment", + "Value": "Prod" + }, + { + "Key": "stack", + "Value": "dev1" + }, + { + "Key": "Name", + "Value": "project-a/nginx-web-app" + } + ] + } + +For more information, see `List tags for a public repository `__ in the *Amazon ECR Public*. diff --git a/awscli/examples/ecr-public/put-registry-catalog-data.rst b/awscli/examples/ecr-public/put-registry-catalog-data.rst new file mode 100644 index 000000000000..57c83973ece1 --- /dev/null +++ b/awscli/examples/ecr-public/put-registry-catalog-data.rst @@ -0,0 +1,15 @@ +**To create or update catalog metadata for a public ECR registry** + +The following ``put-registry-catalog-data`` creates or updates catalog metadata for an ECR public registry. Only accounts that have the verified account badge can have a registry display name. :: + + aws ecr-public put-registry-catalog-data \ + --region us-east-1 \ + --display-name + +Output:: + + { + "registryCatalogData": { + "displayName": "YourCustomPublicRepositoryalias" + } + } diff --git a/awscli/examples/ecr-public/put-repository-catalog-data.rst b/awscli/examples/ecr-public/put-repository-catalog-data.rst index 9be052cdd6ec..678b9fd87c1a 100644 --- a/awscli/examples/ecr-public/put-repository-catalog-data.rst +++ b/awscli/examples/ecr-public/put-repository-catalog-data.rst @@ -1,4 +1,4 @@ -**Example 1: To creates or updates the catalog data for a repository in a public registry.** +**To create or update the catalog data for a repository in a public registry** The following ``put-repository-catalog-data`` example creates or update catalog data for reposiotry named `project-a/nginx-web-app` in a public registry, along with logoImageBlob, aboutText, usageText and tags information. :: @@ -10,6 +10,7 @@ The following ``put-repository-catalog-data`` example creates or update catalog Contents of ``repository-catalog-data.json``:: { + "repositoryName": "project-a/nginx-web-app", "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ @@ -21,9 +22,9 @@ Contents of ``repository-catalog-data.json``:: "operatingSystems": [ "Linux" ], - "logoImageBlob": "iVBORw0KGgoAAAANSUhEUgAAAYYAAAGGCAMAAABIXtbXAAAAq1BMVEVHcEz// ", + "logoImageBlob": "iVBORw0KGgoA<>ErkJggg==", "aboutText": "## Quick reference.", - "usageText": "## Supported architectures are as follows" + "usageText": "## Supported architectures are as follows." } } @@ -41,7 +42,7 @@ Output:: "operatingSystems": [ "Linux" ], - "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/491d3846-8f33-4d8b-a10c-c2ce271e6c0d/4f09d87c-2569-4916-a932-5c296bf6f88a.png", + "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/df86cf58-ee60-4061-b804-0be24d97ccb1/4a9ed9b2-69e4-4ede-b924-461462d20ef0.png", "aboutText": "## Quick reference.", "usageText": "## Supported architectures are as follows." } diff --git a/awscli/examples/ecr-public/tag-resource.rst b/awscli/examples/ecr-public/tag-resource.rst new file mode 100644 index 000000000000..1d070887329b --- /dev/null +++ b/awscli/examples/ecr-public/tag-resource.rst @@ -0,0 +1,21 @@ +**Example 1: To tags an existing public repository in a public registry** + +The following ``tag-resource`` example tags a repository named ``project-a/nginx-web-app`` in a public registry. :: + + aws ecr-public tag-resource \ + --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ + --tags Key=stack,Value=dev \ + --region us-east-1 + +For more information, see `Using Tags for a public repository `__ in the *Amazon ECR Public*. + +**Example 2: To tag an existing public repository with multiple tags in a public registry.** + +The following ``tag-resource`` example tags an existing repository with multiple tags. :: + + aws ecr-public tag-resource \ + --resource-arn arn:aws:ecr-public::890517186334:repository/project-a/nginx-web-app \ + --tags Key=key1,Value=value1 Key=key2,Value=value2 Key=key3,Value=value3 \ + --region us-east-1 + +For more information, see `Using Tags for a public repository `__ in the *Amazon ECR Public*. diff --git a/awscli/examples/ecr-public/untag-resource.rst b/awscli/examples/ecr-public/untag-resource.rst new file mode 100644 index 000000000000..4ff4445b5494 --- /dev/null +++ b/awscli/examples/ecr-public/untag-resource.rst @@ -0,0 +1,12 @@ +**Example 1: To untags an existing public repository in a public registry** + +The following ``untag-resource`` example tags a repository named ``project-a/nginx-web-app`` in a public registry. :: + + aws ecr-public untag-resource \ + --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ + --tag-keys stack \ + --region us-east-1 + +This command produces no output. + +For more information, see `Using Tags for a public repository `__ in the *Amazon ECR Public*.