github.com/aavshr/aws-sdk-go@v1.41.3/service/proton/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package proton provides the client and types for making API 4 // requests to AWS Proton. 5 // 6 // This is the AWS Proton Service API Reference. It provides descriptions, syntax 7 // and usage examples for each of the actions (https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html) 8 // and data types (https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html) 9 // for the AWS Proton service. 10 // 11 // The documentation for each action shows the Query API request parameters 12 // and the XML response. 13 // 14 // Alternatively, you can use the AWS CLI to access an API. For more information, 15 // see the AWS Command Line Interface User Guide (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). 16 // 17 // The AWS Proton service is a two-pronged automation framework. Administrators 18 // create service templates to provide standardized infrastructure and deployment 19 // tooling for serverless and container based applications. Developers, in turn, 20 // select from the available service templates to automate their application 21 // or service deployments. 22 // 23 // Because administrators define the infrastructure and tooling that AWS Proton 24 // deploys and manages, they need permissions to use all of the listed API operations. 25 // 26 // When developers select a specific infrastructure and tooling set, AWS Proton 27 // deploys their applications. To monitor their applications that are running 28 // on AWS Proton, developers need permissions to the service create, list, update 29 // and delete API operations and the service instance list and update API operations. 30 // 31 // To learn more about AWS Proton administration, see the AWS Proton Administrator 32 // Guide (https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html). 33 // 34 // To learn more about deploying serverless and containerized applications on 35 // AWS Proton, see the AWS Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html). 36 // 37 // Ensuring Idempotency 38 // 39 // When you make a mutating API request, the request typically returns a result 40 // before the asynchronous workflows of the operation are complete. Operations 41 // might also time out or encounter other server issues before they're complete, 42 // even if the request already returned a result. This might make it difficult 43 // to determine whether the request succeeded. Moreover, you might need to retry 44 // the request multiple times to ensure that the operation completes successfully. 45 // However, if the original request and the subsequent retries are successful, 46 // the operation occurs multiple times. This means that you might create more 47 // resources than you intended. 48 // 49 // Idempotency ensures that an API request action completes no more than one 50 // time. With an idempotent request, if the original request action completes 51 // successfully, any subsequent retries complete successfully without performing 52 // any further actions. However, the result might contain updated information, 53 // such as the current creation status. 54 // 55 // The following lists of APIs are grouped according to methods that ensure 56 // idempotency. 57 // 58 // Idempotent create APIs with a client token 59 // 60 // The API actions in this list support idempotency with the use of a client 61 // token. The corresponding AWS CLI commands also support idempotency using 62 // a client token. A client token is a unique, case-sensitive string of up to 63 // 64 ASCII characters. To make an idempotent API request using one of these 64 // actions, specify a client token in the request. We recommend that you don't 65 // reuse the same client token for other API requests. If you don’t provide 66 // a client token for these APIs, a default client token is automatically provided 67 // by SDKs. 68 // 69 // Given a request action that has succeeded: 70 // 71 // If you retry the request using the same client token and the same parameters, 72 // the retry succeeds without performing any further actions other than returning 73 // the original resource detail data in the response. 74 // 75 // If you retry the request using the same client token, but one or more of 76 // the parameters are different, the retry throws a ValidationException with 77 // an IdempotentParameterMismatch error. 78 // 79 // Client tokens expire eight hours after a request is made. If you retry the 80 // request with the expired token, a new resource is created. 81 // 82 // If the original resource is deleted and you retry the request, a new resource 83 // is created. 84 // 85 // Idempotent create APIs with a client token: 86 // 87 // * CreateEnvironmentTemplateVersion 88 // 89 // * CreateServiceTemplateVersion 90 // 91 // * CreateEnvironmentAccountConnection 92 // 93 // Idempotent create APIs 94 // 95 // Given a request action that has succeeded: 96 // 97 // If you retry the request with an API from this group, and the original resource 98 // hasn't been modified, the retry succeeds without performing any further actions 99 // other than returning the original resource detail data in the response. 100 // 101 // If the original resource has been modified, the retry throws a ConflictException. 102 // 103 // If you retry with different input parameters, the retry throws a ValidationException 104 // with an IdempotentParameterMismatch error. 105 // 106 // Idempotent create APIs: 107 // 108 // * CreateEnvironmentTemplate 109 // 110 // * CreateServiceTemplate 111 // 112 // * CreateEnvironment 113 // 114 // * CreateService 115 // 116 // Idempotent delete APIs 117 // 118 // Given a request action that has succeeded: 119 // 120 // When you retry the request with an API from this group and the resource was 121 // deleted, its metadata is returned in the response. 122 // 123 // If you retry and the resource doesn't exist, the response is empty. 124 // 125 // In both cases, the retry succeeds. 126 // 127 // Idempotent delete APIs: 128 // 129 // * DeleteEnvironmentTemplate 130 // 131 // * DeleteEnvironmentTemplateVersion 132 // 133 // * DeleteServiceTemplate 134 // 135 // * DeleteServiceTemplateVersion 136 // 137 // * DeleteEnvironmentAccountConnection 138 // 139 // Asynchronous idempotent delete APIs 140 // 141 // Given a request action that has succeeded: 142 // 143 // If you retry the request with an API from this group, if the original request 144 // delete operation status is DELETE_IN_PROGRESS, the retry returns the resource 145 // detail data in the response without performing any further actions. 146 // 147 // If the original request delete operation is complete, a retry returns an 148 // empty response. 149 // 150 // Asynchronous idempotent delete APIs: 151 // 152 // * DeleteEnvironment 153 // 154 // * DeleteService 155 // 156 // See https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20 for more information on this service. 157 // 158 // See proton package documentation for more information. 159 // https://docs.aws.amazon.com/sdk-for-go/api/service/proton/ 160 // 161 // Using the Client 162 // 163 // To contact AWS Proton with the SDK use the New function to create 164 // a new service client. With that client you can make API requests to the service. 165 // These clients are safe to use concurrently. 166 // 167 // See the SDK's documentation for more information on how to use the SDK. 168 // https://docs.aws.amazon.com/sdk-for-go/api/ 169 // 170 // See aws.Config documentation for more information on configuring SDK clients. 171 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 172 // 173 // See the AWS Proton client Proton for more 174 // information on creating client for this service. 175 // https://docs.aws.amazon.com/sdk-for-go/api/service/proton/#New 176 package proton