RetrieveEnvironmentInfo
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- EnvironmentId
-
The ID of the data's environment.
If no such environment is found, returns an
InvalidParameterValue
error.Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.Type: String
Required: No
- EnvironmentName
-
The name of the data's environment.
If no such environment is found, returns an
InvalidParameterValue
error.Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No
- InfoType
-
The type of information to retrieve.
Type: String
Valid Values:
tail | bundle
Required: Yes
Response Elements
The following element is returned by the service.
- EnvironmentInfo.member.N
-
The EnvironmentInfoDescription of the environment.
Type: Array of EnvironmentInfoDescription objects
Errors
For information about the errors that are common to all actions, see Common Errors.
Examples
Example
This example illustrates one usage of RetrieveEnvironmentInfo.
Sample Request
https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&InfoType=tail
&Operation=RetrieveEnvironmentInfo
&AuthParams
Sample Response
<RetrieveEnvironmentInfoResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
<RetrieveEnvironmentInfoResult>
<EnvironmentInfo>
<member>
<Message>
https://elasticbeanstalk.us-east-1.s3.amazonaws.com/environments%2Fa514386a-709f-4888-9683-068c38d744b4%2Flogs%2Fi-92a3ceff%2F278756a8-7d83-4bc1-93db-b1763163705a.log?Expires=1291236023
&AuthParams
</Message>
<SampleTimestamp>2010-11-17T20:40:23.210Z</SampleTimestamp>
<InfoType>tail</InfoType>
<Ec2InstanceId>i-92a3ceff</Ec2InstanceId>
</member>
</EnvironmentInfo>
</RetrieveEnvironmentInfoResult>
<ResponseMetadata>
<RequestId>e8e785c9-f28a-11df-8a78-9f77047e0d0c</RequestId>
</ResponseMetadata>
</RetrieveEnvironmentInfoResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: