From 5ffcd5423e80bfb7f7825a2cf45d99c667b422c8 Mon Sep 17 00:00:00 2001 From: Beck Date: Fri, 9 Jun 2017 11:28:17 -0700 Subject: [PATCH] Added copyright license and metadata block to examples --- docs/examples/cw-examples-getting-metrics.rst | 16 +++++++++++++- .../cw-examples-publishing-custom-metrics.rst | 22 +++++++++++++++---- docs/examples/cw-examples-sending-events.rst | 22 +++++++++++++++---- .../cw-examples-using-alarm-actions.rst | 20 ++++++++++++++--- .../examples/cw-examples-work-with-alarms.rst | 14 ++++++++++++ docs/examples/cw-examples.rst | 10 +++++++++ .../ec2-examples-managing-instances.rst | 14 ++++++++++++ ...c2-examples-using-elastic-ip-addresses.rst | 14 ++++++++++++ .../ec2-examples-using-regions-and-zones.rst | 14 ++++++++++++ .../ec2-examples-using-security-groups.rst | 14 ++++++++++++ .../ec2-examples-working-with-key-pairs.rst | 14 ++++++++++++ docs/examples/ec2-examples.rst | 12 +++++++++- .../iam-examples-managing-access-keys.rst | 14 ++++++++++++ docs/examples/iam-examples-managing-users.rst | 14 ++++++++++++ .../iam-examples-using-account-aliases.rst | 14 ++++++++++++ .../iam-examples-working-with-certs.rst | 14 ++++++++++++ .../iam-examples-working-with-policies.rst | 14 ++++++++++++ docs/examples/iam-examples.rst | 10 +++++++++ docs/examples/index.rst | 10 +++++++++ .../s3-examples-access-permissions.rst | 14 ++++++++++++ docs/examples/s3-examples-bucket-policies.rst | 14 ++++++++++++ .../s3-examples-configuring-a-bucket.rst | 14 ++++++++++++ .../examples/s3-examples-creating-buckets.rst | 14 ++++++++++++ docs/examples/s3-examples-static-web-host.rst | 14 ++++++++++++ docs/examples/s3-examples.rst | 10 +++++++++ .../sqs-examples-dead-letter-queues.rst | 14 ++++++++++++ .../sqs-examples-enable-long-polling.rst | 16 +++++++++++++- ...s-examples-managing-visibility-timeout.rst | 16 +++++++++++++- .../sqs-examples-send-receive-messages.rst | 14 ++++++++++++ docs/examples/sqs-examples-using-queues.rst | 16 +++++++++++++- docs/examples/sqs-examples.rst | 10 +++++++++ 31 files changed, 426 insertions(+), 16 deletions(-) diff --git a/docs/examples/cw-examples-getting-metrics.rst b/docs/examples/cw-examples-getting-metrics.rst index eb88873ccc..ee7111baf6 100644 --- a/docs/examples/cw-examples-getting-metrics.rst +++ b/docs/examples/cw-examples-getting-metrics.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ====================================== Getting Metrics from Amazon CloudWatch ====================================== +.. meta:: + :description: List Amazon CloudWatch metrics, retrieve alarms for metrics, and get metric statistics. + :keywords: Amazon Cloudwatch, AWS SDK for PHP examples + Metrics are data about the performance of your systems. You can enable detailed monitoring of some resources, such as your Amazon EC2 instances, or your own application metrics. The examples below show how to: @@ -47,7 +61,7 @@ Retrieve Alarms for a Metric require 'vendor/autoload.php'; use Aws\CloudWatch\CloudWatchClient; use Aws\Exception\AwsException; - + $client = new CloudWatchClient([ 'profile' => 'default', 'region' => 'us-west-2', diff --git a/docs/examples/cw-examples-publishing-custom-metrics.rst b/docs/examples/cw-examples-publishing-custom-metrics.rst index dd2349c338..286edf2de0 100644 --- a/docs/examples/cw-examples-publishing-custom-metrics.rst +++ b/docs/examples/cw-examples-publishing-custom-metrics.rst @@ -1,6 +1,20 @@ -======================================= -Publishing Custom Metrics in CloudWatch -======================================= +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + +============================================== +Publishing Custom Metrics in Amazon CloudWatch +============================================== + +.. meta:: + :description: Publish metric data and create alarms for Amazon CloudWatch. + :keywords: Amazon CloudWatch, AWS SDK for PHP examples Metrics are data about the performance of your systems. An alarm watches a single metric over a time period you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. @@ -57,7 +71,7 @@ Create an Alarm require 'vendor/autoload.php'; use Aws\CloudWatch\CloudWatchClient; use Aws\Exception\AwsException; - + $client = new CloudWatchClient([ 'profile' => 'default', 'region' => 'us-west-2', diff --git a/docs/examples/cw-examples-sending-events.rst b/docs/examples/cw-examples-sending-events.rst index 683e87819d..7da8d4be63 100644 --- a/docs/examples/cw-examples-sending-events.rst +++ b/docs/examples/cw-examples-sending-events.rst @@ -1,6 +1,20 @@ -=================================== -Sending Events to CloudWatch Events -=================================== +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + +========================================== +Sending Events to Amazon CloudWatch Events +========================================== + +.. meta:: + :description: Create rules and add targets to them, and send custom events to CloudWatch Events. + :keywords: Amazon Cloudwatch, AWS SDK for PHP examples CloudWatch Events delivers a near real-time stream of system events that describe changes in Amazon Web Services (AWS) resources to any of various targets. Using simple rules, you can match events and route them to one or more target functions or streams. @@ -52,7 +66,7 @@ Add Targets to a Rule require 'vendor/autoload.php'; use Aws\CloudWatchEvents\CloudWatchEventsClient; use Aws\Exception\AwsException; - + $client = new CloudWatchEventsClient([ 'profile' => 'default', 'region' => 'us-west-2', diff --git a/docs/examples/cw-examples-using-alarm-actions.rst b/docs/examples/cw-examples-using-alarm-actions.rst index 9512439955..27c1c1d785 100644 --- a/docs/examples/cw-examples-using-alarm-actions.rst +++ b/docs/examples/cw-examples-using-alarm-actions.rst @@ -1,6 +1,20 @@ -============================== -Working with CloudWatch Alarms -============================== +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + +================================================= +Using Alarm Actions with Amazon CloudWatch Alarms +================================================= + +.. meta:: + :description: Create CloudWatch alarms that automatically stop, terminate, reboot, or recover EC2 instances. + :keywords: Amazon Cloudwatch, AWS SDK for PHP examples Using alarm actions, you can create alarms that automatically stop, terminate, reboot, or recover your Amazon EC2 instances. You can use the stop or terminate actions when you no longer need an instance to be running. You can use the reboot and recover actions to automatically reboot those instances. diff --git a/docs/examples/cw-examples-work-with-alarms.rst b/docs/examples/cw-examples-work-with-alarms.rst index bf1058c346..d2320b1452 100644 --- a/docs/examples/cw-examples-work-with-alarms.rst +++ b/docs/examples/cw-examples-work-with-alarms.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ===================================== Working with Amazon CloudWatch Alarms ===================================== +.. meta:: + :description: Create CloudWatch alarms that automatically stop, terminate, reboot, or recover EC2 instances. + :keywords: Amazon CloudWatch, AWS SDK for PHP examples + An Amazon CloudWatch alarm watches a single metric over a time period you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The examples below show how to: diff --git a/docs/examples/cw-examples.rst b/docs/examples/cw-examples.rst index 17e6d30a7e..f55e2e76e1 100644 --- a/docs/examples/cw-examples.rst +++ b/docs/examples/cw-examples.rst @@ -1,3 +1,13 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ================= Amazon CloudWatch ================= diff --git a/docs/examples/ec2-examples-managing-instances.rst b/docs/examples/ec2-examples-managing-instances.rst index e62f5945f2..34989ea3f8 100644 --- a/docs/examples/ec2-examples-managing-instances.rst +++ b/docs/examples/ec2-examples-managing-instances.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================= Managing Amazon EC2 Instances ============================= +.. meta:: + :description: + :keywords: Amazon EC2, AWS SDK for PHP examples + The examples below show how to: * Describe EC2 instances using `DescribeInstances `_. diff --git a/docs/examples/ec2-examples-using-elastic-ip-addresses.rst b/docs/examples/ec2-examples-using-elastic-ip-addresses.rst index c485e820d6..bab5ac98e3 100644 --- a/docs/examples/ec2-examples-using-elastic-ip-addresses.rst +++ b/docs/examples/ec2-examples-using-elastic-ip-addresses.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========================================== Using Elastic IP Addresses with Amazon EC2 ========================================== +.. meta:: + :description: Describe Amazon EC2 instances and acquire, associate, and release Elastic IP addresses. + :keywords: Amazon EC2, AWS SDK for PHP examples + An Elastic IP address is a static IP address designed for dynamic cloud computing. An Elastic IP address is associated with your AWS account. It is a public IP address, which is reachable from the Internet. If your instance does not have a public IP address, you can associate an Elastic IP address with your instance to enable communication with the Internet. The examples below show how to: diff --git a/docs/examples/ec2-examples-using-regions-and-zones.rst b/docs/examples/ec2-examples-using-regions-and-zones.rst index 06be51f9ca..2cb52a598b 100644 --- a/docs/examples/ec2-examples-using-regions-and-zones.rst +++ b/docs/examples/ec2-examples-using-regions-and-zones.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ==================================== Using Regions and Availability Zones ==================================== +.. meta:: + :description: Describe AWS Regions and Availability Zones for Amazon EC2. + :keywords: Amazon EC2, AWS SDK for PHP examples + Amazon EC2 is hosted in multiple locations worldwide. These locations are composed of regions and Availability Zones. Each region is a separate geographic area. Each region has multiple, isolated locations known as Availability Zones. Amazon EC2 provides the ability to place instances and data in multiple locations. The examples below show how to: diff --git a/docs/examples/ec2-examples-using-security-groups.rst b/docs/examples/ec2-examples-using-security-groups.rst index 611fb5836d..a366a8420c 100644 --- a/docs/examples/ec2-examples-using-security-groups.rst +++ b/docs/examples/ec2-examples-using-security-groups.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================ Working with Security Groups ============================ +.. meta:: + :description: Create, describe, and delete security groups for Amazon EC2. + :keywords: Amazon EC2, AWS SDK for PHP examples + An Amazon EC2 security group acts as a virtual firewall that controls the traffic for one or more instances. You add rules to each security group to allow traffic to or from its associated instances. You can modify the rules for a security group at any time; the new rules are automatically applied to all instances that are associated with the security group. The examples below show how to: diff --git a/docs/examples/ec2-examples-working-with-key-pairs.rst b/docs/examples/ec2-examples-working-with-key-pairs.rst index 82f58a4323..89ee4c6c43 100644 --- a/docs/examples/ec2-examples-working-with-key-pairs.rst +++ b/docs/examples/ec2-examples-working-with-key-pairs.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ================================= Working with Amazon EC2 Key Pairs ================================= +.. meta:: + :description: Create and delete key pairs for Amazon EC2. + :keywords: Amazon EC2, AWS SDK for PHP examples + Amazon EC2 uses public–key cryptography to encrypt and decrypt login information. Public–key cryptography uses a public key to encrypt data; then the recipient uses the private key to decrypt the data. The public and private keys are known as a key pair. The examples below show how to: diff --git a/docs/examples/ec2-examples.rst b/docs/examples/ec2-examples.rst index ef79a2cbfc..0790ae3977 100644 --- a/docs/examples/ec2-examples.rst +++ b/docs/examples/ec2-examples.rst @@ -1,8 +1,18 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========== Amazon EC2 ========== -Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides virtual server hosting in the cloud. It's designed to make web-scale cloud computing easier for developers by providing resizeable compute capacity. +Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides virtual server hosting in the cloud. It's designed to make web-scale cloud computing easier for developers by providing resizeable compute capacity. .. toctree:: :maxdepth: 1 diff --git a/docs/examples/iam-examples-managing-access-keys.rst b/docs/examples/iam-examples-managing-access-keys.rst index 09f18340e7..c969d98c4b 100644 --- a/docs/examples/iam-examples-managing-access-keys.rst +++ b/docs/examples/iam-examples-managing-access-keys.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ======================== Managing IAM Access Keys ======================== +.. meta:: + :description: Create, delete, and get information about IAM access keys. + :keywords: AWS Identity and Access Management, AWS SDK for PHP examples + Users need their own access keys to make programmatic calls to AWS. To fill this need, you can create, modify, view, or rotate access keys (access key IDs and secret access keys) for IAM users. By default, when you create an access key, its status is Active, which means the user can use the access key for API calls. The examples below show how to: diff --git a/docs/examples/iam-examples-managing-users.rst b/docs/examples/iam-examples-managing-users.rst index 209387c90e..b91abbc6c0 100644 --- a/docs/examples/iam-examples-managing-users.rst +++ b/docs/examples/iam-examples-managing-users.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ================== Managing IAM Users ================== +.. meta:: + :description: Create, list, update, or retrieve info about IAM users. + :keywords: AWS Identity and Access Management, AWS SDK for PHP examples + An IAM user is an entity that you create in AWS to represent the person or service that uses it to interact with AWS. A user in AWS consists of a name and credentials. The examples below show how to: diff --git a/docs/examples/iam-examples-using-account-aliases.rst b/docs/examples/iam-examples-using-account-aliases.rst index 46953bc040..04f8cd6813 100644 --- a/docs/examples/iam-examples-using-account-aliases.rst +++ b/docs/examples/iam-examples-using-account-aliases.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========================= Using IAM Account Aliases ========================= +.. meta:: + :description: Create, list, and delete aliases for AWS accout IDs using IAM. + :keywords: AWS Identity and Access Management, AWS SDK for PHP examples + If you want the URL for your sign-in page to contain your company name or other friendly identifier instead of your AWS account ID, you can create an alias for your AWS account ID. If you create an AWS account alias, your sign-in page URL changes to incorporate the alias. The examples below show how to: diff --git a/docs/examples/iam-examples-working-with-certs.rst b/docs/examples/iam-examples-working-with-certs.rst index fd0f54c8cd..7bcaace7eb 100644 --- a/docs/examples/iam-examples-working-with-certs.rst +++ b/docs/examples/iam-examples-working-with-certs.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ==================================== Working with IAM Server Certificates ==================================== +.. meta:: + :description: List, update, and get information about certificates using IAM. + :keywords: AWS Identity and Access Management, AWS SDK for PHP examples + To enable HTTPS connections to your website or application on AWS, you need an SSL/TLS server certificate. To use a certificate that you obtained from an external provider with your website or application on AWS, you must upload the certificate to IAM or import it into AWS Certificate Manager. The examples below show how to: diff --git a/docs/examples/iam-examples-working-with-policies.rst b/docs/examples/iam-examples-working-with-policies.rst index 3dbe2a388f..bff7b6afd7 100644 --- a/docs/examples/iam-examples-working-with-policies.rst +++ b/docs/examples/iam-examples-working-with-policies.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========================= Working with IAM Policies ========================= +.. meta:: + :description: Create, attach, or remove IAM user policies. + :keywords: AWS Identity and Access Management, AWS SDK for PHP examples + You grant permissions to a user by creating a policy, which is a document that lists the actions that a user can perform and the resources those actions can affect. Any actions or resources that are not explicitly allowed are denied by default. Policies can be created and attached to users, groups of users, roles assumed by users, and resources. The examples below show how to: diff --git a/docs/examples/iam-examples.rst b/docs/examples/iam-examples.rst index 5242a1e0e7..da20601223 100644 --- a/docs/examples/iam-examples.rst +++ b/docs/examples/iam-examples.rst @@ -1,3 +1,13 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ======= AWS IAM ======= diff --git a/docs/examples/index.rst b/docs/examples/index.rst index 8ca774798d..9e010c6f17 100644 --- a/docs/examples/index.rst +++ b/docs/examples/index.rst @@ -1,3 +1,13 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============= Code Examples ============= diff --git a/docs/examples/s3-examples-access-permissions.rst b/docs/examples/s3-examples-access-permissions.rst index b13e81ccc5..d1777874db 100644 --- a/docs/examples/s3-examples-access-permissions.rst +++ b/docs/examples/s3-examples-access-permissions.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================================ Managing Amazon S3 Bucket Access Permissions ============================================ +.. meta:: + :description: Get ACLs and set permissions for Amazon S3 buckets. + :keywords: Amazon S3, AWS SDK for PHP examples + Access control lists (ACLs) are one of the resource-based access policy options you can use to manage access to your buckets and objects. You can use ACLs to grant basic read/write permissions to other AWS accounts. To learn more, see `Managing Access with ACLs `_. The example below shows how to: diff --git a/docs/examples/s3-examples-bucket-policies.rst b/docs/examples/s3-examples-bucket-policies.rst index 65c6071f98..af447d5f75 100644 --- a/docs/examples/s3-examples-bucket-policies.rst +++ b/docs/examples/s3-examples-bucket-policies.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ====================================== Working with Amazon S3 Bucket Policies ====================================== +.. meta:: + :description: Return, replace, or delete Amazon S3 bucket policies. + :keywords: Amazon S3, AWS SDK for PHP examples + You can use a bucket policy to grant permission to your Amazon S3 resources. To learn more, see `Using Bucket Policies and User Policies `_. The example below shows how to: diff --git a/docs/examples/s3-examples-configuring-a-bucket.rst b/docs/examples/s3-examples-configuring-a-bucket.rst index b3f1cece6b..c6acae45d4 100644 --- a/docs/examples/s3-examples-configuring-a-bucket.rst +++ b/docs/examples/s3-examples-configuring-a-bucket.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================= Configuring Amazon S3 Buckets ============================= +.. meta:: + :description: Get or set CORS configuration for an Amazon S3 bucket. + :keywords: Amazon S3, AWS SDK for PHP examples + Cross-origin resource sharing (CORS) defines a way for client web applications that are loaded in one domain to interact with resources in a different domain. With CORS support in Amazon S3, you can build rich client-side web applications with Amazon S3 and selectively allow cross-origin access to your Amazon S3 resources. For more information about using CORS configuration with an Amazon S3 bucket, see `Cross-Origin Resource Sharing (CORS) `_. diff --git a/docs/examples/s3-examples-creating-buckets.rst b/docs/examples/s3-examples-creating-buckets.rst index 50dc1d0346..049ff3a8f9 100644 --- a/docs/examples/s3-examples-creating-buckets.rst +++ b/docs/examples/s3-examples-creating-buckets.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ==================================== Creating and Using Amazon S3 Buckets ==================================== +.. meta:: + :description: + :keywords: Amazon S3, AWS SDK for PHP examples + The examples below show how to: * Return a list of buckets owned by the authenticated sender of the request using `ListBuckets `_. diff --git a/docs/examples/s3-examples-static-web-host.rst b/docs/examples/s3-examples-static-web-host.rst index 9f39fc5cb8..47b76db8d4 100644 --- a/docs/examples/s3-examples-static-web-host.rst +++ b/docs/examples/s3-examples-static-web-host.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================================== Using an Amazon S3 Bucket as a Static Web Host ============================================== +.. meta:: + :description: Get, set, and remove website configuration for an Amazon S3 bucket. + :keywords: Amazon S3, AWS SDK for PHP examples + You can host a static website on Amazon S3. To learn more, see `Hosting a Static Website on Amazon S3 `_. The example below shows how to: diff --git a/docs/examples/s3-examples.rst b/docs/examples/s3-examples.rst index f9ec819fd2..b05fc1908f 100644 --- a/docs/examples/s3-examples.rst +++ b/docs/examples/s3-examples.rst @@ -1,3 +1,13 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========= Amazon S3 ========= diff --git a/docs/examples/sqs-examples-dead-letter-queues.rst b/docs/examples/sqs-examples-dead-letter-queues.rst index e7f9b2e529..68c6f0a3ff 100644 --- a/docs/examples/sqs-examples-dead-letter-queues.rst +++ b/docs/examples/sqs-examples-dead-letter-queues.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ====================================== Using Dead Letter Queues in Amazon SQS ====================================== +.. meta:: + :description: Enable dead letter queues with Amazon SQS. + :keywords: Amazon SQS, AWS SDK for PHP examples + A dead letter queue is one that other (source) queues can target for messages that can't be processed successfully. You can set aside and isolate these messages in the dead letter queue to determine why their processing did not succeed. You must individually configure each source queue that sends messages to a dead letter queue. Multiple queues can target a single dead letter queue. To learn more, see `Using Amazon SQS Dead Letter Queues `_. diff --git a/docs/examples/sqs-examples-enable-long-polling.rst b/docs/examples/sqs-examples-enable-long-polling.rst index 790a7f4878..26c6209de2 100644 --- a/docs/examples/sqs-examples-enable-long-polling.rst +++ b/docs/examples/sqs-examples-enable-long-polling.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + =================================== Enabling Long Polling in Amazon SQS =================================== +.. meta:: + :description: + :keywords: Amazon SQS, AWS SDK for PHP examples + Long polling reduces the number of empty responses by allowing Amazon SQS to wait a specified time for a message to become available in the queue before sending a response. Also, long polling eliminates false empty responses by querying all of the servers instead of a sampling of servers. To enable long polling, you must specify a non-zero wait time for received messages. To learn more, see `Amazon SQS Long Polling `_. The examples below show how to: @@ -82,7 +96,7 @@ Create a Queue with Long Polling require 'vendor/autoload.php'; use Aws\Sqs\SqsClient; use Aws\Exception\AwsException; - + $queueName = "QUEUE_NAME"; $client = new SqsClient([ 'profile' => 'default', diff --git a/docs/examples/sqs-examples-managing-visibility-timeout.rst b/docs/examples/sqs-examples-managing-visibility-timeout.rst index e8bbc499bd..34a5d02a58 100644 --- a/docs/examples/sqs-examples-managing-visibility-timeout.rst +++ b/docs/examples/sqs-examples-managing-visibility-timeout.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========================================= Managing Visibility Timeout in Amazon SQS ========================================= +.. meta:: + :description: Change the visibility timeout for messages in Amazon SQS. + :keywords: Amazon SQS, AWS SDK for PHP examples + A visibility timeout is a period of time during which Amazon SQS prevents other consuming components from receiving and processing a message. To learn more, see `Visibility Timeout `_. The example below shows how to: @@ -23,7 +37,7 @@ Change the Visibility Timeout of Multiple Messages require 'vendor/autoload.php'; use Aws\Sqs\SqsClient; use Aws\Exception\AwsException; - + $queueUrl = "QUEUE_URL"; $client = new SqsClient([ 'profile' => 'default', diff --git a/docs/examples/sqs-examples-send-receive-messages.rst b/docs/examples/sqs-examples-send-receive-messages.rst index d4947c9a4b..9cc123921e 100644 --- a/docs/examples/sqs-examples-send-receive-messages.rst +++ b/docs/examples/sqs-examples-send-receive-messages.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ============================================ Sending and Receiving Messages in Amazon SQS ============================================ +.. meta:: + :description: Deliver, delete, or retrieve messages using Amazon SQS. + :keywords: Amazon SQS, AWS SDK for PHP examples + To learn about Amazon SQS messages, see `Sending a Message to an Amazon SQS Queue `_ and `Receiving and Deleting a Message from an Amazon SQS Queue `_ in the Amazon Simple Queue Service Developer Guide. The examples below show how to: diff --git a/docs/examples/sqs-examples-using-queues.rst b/docs/examples/sqs-examples-using-queues.rst index 4e7f83f298..e1200e3e7e 100644 --- a/docs/examples/sqs-examples-using-queues.rst +++ b/docs/examples/sqs-examples-using-queues.rst @@ -1,7 +1,21 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========================== Using Queues in Amazon SQS ========================== +.. meta:: + :description: Create or delete Amazon SQS queues, and return lists and URLs for queues. + :keywords: Amazon SQS, AWS SDK for PHP examples + To learn about Amazon SQS queues, see `How Amazon SQS Queues Work `_. The examples below show how to: @@ -104,7 +118,7 @@ Delete a Queue require 'vendor/autoload.php'; use Aws\Sqs\SqsClient; use Aws\Exception\AwsException; - + $queueUrl = "SQS_QUEUE_URL"; $client = new SqsClient([ 'profile' => 'default', diff --git a/docs/examples/sqs-examples.rst b/docs/examples/sqs-examples.rst index be572a3c50..c9808edb2b 100644 --- a/docs/examples/sqs-examples.rst +++ b/docs/examples/sqs-examples.rst @@ -1,3 +1,13 @@ +.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 + International License (the "License"). You may not use this file except in compliance with the + License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. + + This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific language governing permissions and + limitations under the License. + ========== Amazon SQS ==========